AICursorConstraint Struct Reference

Structure describing a custom constraint for AICursorSnapSuite. More...

#include <AICursorSnap.h>

List of all members.

Public Member Functions
	AICursorConstraint (const ai::int32 inKind, const ai::int32 inFlags, const AIRealPoint &inPoint, const AIReal inAngle, const ai::UnicodeString &inLabel, const CustomAnnotationsCallback inCustomAnnotationsCallback)
	AICursorConstraint ()
	~AICursorConstraint ()
Public Attributes
ai::int32	kind
	Type of constraint, one of:.
ai::int32	flags
	Flags for the constraint.
AIRealPoint	point
	Origin point for the constraint.
AIReal	angle
	When kind is kLinearConstraintRel, the angle of the line.
ai::UnicodeString	label
	Label for the constraint presented to the user.
CustomAnnotationsCallback	getCustomAnnotationDetails
	Callback function registered by client to retrieve details for drawing custom annotations.

---

Detailed Description

Structure describing a custom constraint for AICursorSnapSuite.

---

Constructor & Destructor Documentation

AICursorConstraint::AICursorConstraint	(	const ai::int32	inKind,
		const ai::int32	inFlags,
		const AIRealPoint &	inPoint,
		const AIReal	inAngle,
		const ai::UnicodeString &	inLabel,
		const CustomAnnotationsCallback	inCustomAnnotationsCallback
	)			[inline]

AICursorConstraint::AICursorConstraint

(

)

[inline]

References _t_AIRealPoint::h, kAIRealZero, point, and _t_AIRealPoint::v.

AICursorConstraint::~AICursorConstraint

(

)

[inline]

---

Member Data Documentation

AIReal AICursorConstraint::angle

When kind is kLinearConstraintRel, the angle of the line.

ai::int32 AICursorConstraint::flags

Flags for the constraint.

The only flag is kShiftConstraint, which means snap to the constraint when the shift key is down.

CustomAnnotationsCallback AICursorConstraint::getCustomAnnotationDetails

Callback function registered by client to retrieve details for drawing custom annotations.

ai::int32 AICursorConstraint::kind

Type of constraint, one of:.

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

ai::UnicodeString AICursorConstraint::label

Label for the constraint presented to the user.

Keep the maximum size to be 256 bytes

AIRealPoint AICursorConstraint::point

Origin point for the constraint.

Referenced by AICursorConstraint().

---

The documentation for this struct was generated from the following file:

• AICursorSnap.h