API: AIPerspectiveGrid.h Source File

00001 #ifndef __AIPerspectiveGrid__
00002 #define __AIPerspectiveGrid__
00003 
00004 /*
00005 *                Name:  AIPerspectiveGrid.h
00006 *        Date:  Started 2009
00007 *     Purpose:  Adobe Illustrator Perspective Grid suite. This suite lets
00008 *                               clients query different settings from the currently defined
00009 *                               Perspective Grid in the document.
00010 *
00011 * ADOBE SYSTEMS INCORPORATED
00012 * Copyright 2009 Adobe Systems Incorporated.
00013 * All rights reserved.
00014 *
00015 * NOTICE:  Adobe permits you to use, modify, and distribute this file
00016 * in accordance with the terms of the Adobe license agreement
00017 * accompanying it. If you have received this file from a source other
00018 * than Adobe, then your use, modification, or distribution of it
00019 * requires the prior written permission of Adobe.
00020 *
00021 */
00022 
00023 /*******************************************************************************
00024 **
00025 **      Imports
00026 **
00027 **/
00028 
00029 #include "AITypes.h"
00030 #include "AIPerspectiveTransform.h"
00031 
00032 #include "AIHeaderBegin.h"
00033 
00036 /*******************************************************************************
00037 **
00038 ** Constants
00039 **
00040 **/
00041 
00042 #define kAIPerspectiveGridSuite                                 "AI Perspective Grid Suite"
00043 #define kAIPerspectiveGridSuiteVersion                  AIAPI_VERSION(3)
00044 #define kAIPerspectiveGridVersion                               kAIPerspectiveGridSuiteVersion
00045 
00049 #define kAIPerspectiveParamsChangedNotifier             "AI Perspective Parameters Changed Notifier"
00050 
00054 #define kAIPerspectiveGridVisibilityChangedNotifier             "AI Perspective Grid Visibility Changed Notifier"
00055 
00056 
00057 /*******************************************************************************
00058 **
00059 ** Types
00060 **
00061 **/
00062 
00065 enum PerspectiveGridType
00066 {
00067         kInvalidGridType = 0,   
00068         kOnePointGridType,              
00069         kTwoPointGridType,              
00070         kThreePointGridType             
00071 };
00072 
00073 /*******************************************************************************
00074 **
00075 **      Suite
00076 **
00077 **/
00078 
00099 typedef struct {
00100 
00105         AIAPI AIBoolean (*IsGridVisible) ();
00106 
00111         AIAPI AIErr (*ShowGrid)(AIBoolean flag);
00112 
00117         AIAPI AIBoolean (*IsGridDefined)();
00118 
00123         AIAPI AIBoolean (*IsGridLocked)();
00124 
00128         AIAPI AIErr (*LockGrid)(AIBoolean flag);
00129 
00135         AIAPI AIBoolean (*IsGridStationPointLocked)();
00136 
00141         AIAPI AIErr (*LockGridStationPoint)(AIBoolean flag);
00142 
00148         AIAPI AIBoolean (*IsGridRulerVisible)();
00149 
00154         AIAPI AIErr (*ShowGridRuler)(AIBoolean flag);
00155 
00161         AIAPI AIBoolean (*IsSnapToGridEnabled)();
00162 
00167         AIAPI AIErr (*SnapToGrid)(AIBoolean flag);
00168 
00173         AIAPI AIErr (*GetGridSnapTolerance) (AIReal& snapTolerance);
00174 
00177         AIAPI AIErr (*SetDefaultPreset)();
00178 
00183         AIAPI AIErr (*ArtworkPointToPGPoint) (AIRealPoint& pt, GridPlaneType plane);
00184 
00189         AIAPI AIErr (*PGPointToArtworkPoint)(AIRealPoint& pt, GridPlaneType plane);
00190 
00194         AIAPI AIErr (*GetPGRulerUnit)(AIUnits& unit);
00195 
00199         AIAPI AIErr     (*SwitchActivePlane) ();
00200 
00205         AIAPI AIErr     (*SetActivePlane) (GridPlaneType gridPlane);
00206 
00211         AIAPI AIErr     (*GetActivePlane) (GridPlaneType& out_gridPlaneType);
00212 
00216         AIAPI AIErr     (*GetActiveGridType) (PerspectiveGridType& out_gridType);
00217 
00224         AIAPI AIErr     (*SwitchActivePlaneFromKB) ();
00225 
00226 } AIPerspectiveGridSuite;
00227 
00228 #include "AIHeaderEnd.h"
00229 
00230 #endif // __AIPerspectiveGrid__