AICursorSnap.h File Reference

#include "AITypes.h"
#include "AIDocumentView.h"
#include "AITool.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AICustomAnnotationLine
struct	AICursorConstraint
	Structure describing a custom constraint for AICursorSnapSuite. More...
struct	AICursorSnapSuite
	Tools that use the Smart Guides snapping facility use these functions in the cursor-tracking code. More...
Defines
#define	kAICursorSnapSuite   "AI Cursor Snap Suite"
#define	kAICursorSnapSuiteVersion16   AIAPI_VERSION(16)
#define	kAICursorSnapSuiteVersion   kAICursorSnapSuiteVersion16
#define	kAICursorSnapVersion   kAICursorSnapSuiteVersion
#define	kShiftConstraint   (1<<0L)
	Flags for custom constraints: See AICursorSnapSuite.
#define	kDrawCustomAnnotations   (1<<1L)
Typedefs
typedef AICustomAnnotationLine *	AICustomAnnotationLinePtr
typedef AIErr(*	CustomAnnotationsCallback )(ai::uint32 inId, const AIRealPoint &inSnappedPt, size_t *outNumberOfLines, AICustomAnnotationLine **outAnnotationLines)
	Function pointer type to retrieve details of custom annotations to be drawn (if kDrawCustomAnnotations flag is set).
Enumerations
enum	{ kPointConstraint = 1, kLinearConstraintAbs, kLinearConstraintRel }
	Kinds of custom constraints for AICursorSnapSuite. More...
enum	{ kTranslateBoundaryEditor = 1 }
	Boundary editors for the transformation tools. More...

---

Detailed Description

---

Define Documentation

#define kAICursorSnapSuite   "AI Cursor Snap Suite"

#define kAICursorSnapSuiteVersion   kAICursorSnapSuiteVersion16

#define kAICursorSnapSuiteVersion16   AIAPI_VERSION(16)

#define kAICursorSnapVersion   kAICursorSnapSuiteVersion

#define kDrawCustomAnnotations   (1<<1L)

#define kShiftConstraint   (1<<0L)

Flags for custom constraints: See AICursorSnapSuite.

---

Typedef Documentation

typedef AICustomAnnotationLine* AICustomAnnotationLinePtr

typedef AIErr(* CustomAnnotationsCallback)(ai::uint32 inId, const AIRealPoint &inSnappedPt, size_t *outNumberOfLines, AICustomAnnotationLine **outAnnotationLines)

Function pointer type to retrieve details of custom annotations to be drawn (if kDrawCustomAnnotations flag is set).

The function pointer is set in AICursorConstraint struct during constraint addition. When the custom constraint is hit and annotations are ready to be drawn, the callback is invoked.

Parameters:

	inId	ConstraintId of the custom constraint hit
	inSnappedPt	The point we snapped to
	outNumberOfLines	Number Of Annotation Lines to be drawn (To be Filled by the callback)
	outAnnotationLines	An array of custom annotation lines to be drawn (To be Filled by the callback) The calling function is responsible to destroy the array of points.

---

Enumeration Type Documentation

anonymous enum

Boundary editors for the transformation tools.

See AICursorSnapSuite.

Enumerator:

kTranslateBoundaryEditor

anonymous enum

Kinds of custom constraints for AICursorSnapSuite.

Enumerator:

kPointConstraint	Single point.
kLinearConstraintAbs	A line whose angle is relative to the page coordinates.
kLinearConstraintRel	A line whose angle is relative to the constraint angle.