AIAnnotatorDrawerSuite Struct Reference
[API Suite List]

The annotator drawer suite allows plug-ins to draw annotations into the document window that are not a part of the artwork. More...

#include <AIAnnotatorDrawer.h>

List of all members.

Public Attributes
Color

AIAPI void(*	SetColor )(AIAnnotatorDrawer *drawer, const AIRGBColor &color)
	Sets the drawing color for an annotation.
AIAPI void(*	GetColor )(AIAnnotatorDrawer *drawer, AIRGBColor &color)
	Retrieves the current drawing color for an annotation.
Lines and shapes

AIAPI void(*	SetLineWidth )(AIAnnotatorDrawer *drawer, const AIReal newWidth)
	Sets the line width for an annotation.
AIAPI AIReal(*	GetLineWidth )(AIAnnotatorDrawer *drawer)
	Retrieves the line width for an annotation.
AIAPI void(*	SetLineDashed )(AIAnnotatorDrawer *drawer, AIBoolean dashed)
	Turns dashed-line drawing on or off for an annotation.
AIAPI AIBoolean(*	GetLineDashed )(AIAnnotatorDrawer *drawer)
	Reports the current dashed-line drawing state for an annotation.
AIAPI AIErr(*	DrawLine )(AIAnnotatorDrawer *drawer, const AIPoint &start, const AIPoint &end)
	Draws a line between two points in an annotation.
AIAPI AIErr(*	DrawRect )(AIAnnotatorDrawer *drawer, const AIRect &rect, AIBoolean fill)
	Draws a rectangle in an annotation.
AIAPI AIErr(*	DrawPolygon )(AIAnnotatorDrawer *drawer, const AIPoint points[], ai::uint32 numPoints, AIBoolean fill)
	Draws a polygon in an annotation by connecting a set of points.
AIAPI AIErr(*	DrawEllipse )(AIAnnotatorDrawer *drawer, const AIRect &rect, AIBoolean fill)
	Draws an ellipse bounded by the rectangle in an annotation.
AIAPI AIErr(*	DrawBezier )(AIAnnotatorDrawer *drawer, const AIPoint &start, const AIPoint pointSets[][3], ai::uint32 numPointSets, AIBoolean fill)
	Draws cubic Bezier curves in an annotation by threading through a set of points.
AIAPI AIErr(*	SetLineDashedEx )(AIAnnotatorDrawer *drawer, AIFloat dashData[], ai::int32 numDashes)
	Sets the dashing pattern for dashed-line drawing for an annotation.
AIAPI AIErr(*	GetLineDashedEx )(AIAnnotatorDrawer *drawer, AIFloat dashData[], ai::int32 &numDashes)
	Retrieves the dashing pattern for dashed-line drawing for an annotation.
Text and Fonts

AIAPI AIErr(*	DrawText )(AIAnnotatorDrawer *drawer, const ai::UnicodeString &text, const AIPoint &bottomLeft)
	Draws text into an annotation.
AIAPI AIErr(*	DrawTextAligned )(AIAnnotatorDrawer *drawer, const ai::UnicodeString &text, const AIHorizAlignment horizAlign, const AIVertAlignment vertAlign, const AIRect &rect)
	Draws text into a rectangle in an annotation, with given alignment.
AIAPI AIErr(*	GetTextBounds )(AIAnnotatorDrawer drawer, const ai::UnicodeString &text, AIPoint location, AIBoolean useFontFallback, AIRect &bounds)
	Finds the bounds of text if it were drawn in the current font at the current size.
AIAPI void(*	SetFontSize )(AIAnnotatorDrawer *drawer, const AIReal size)
	Sets the font size for text drawn into a annotation.
AIAPI AIReal(*	GetFontSize )(AIAnnotatorDrawer *drawer)
	Retrieves the font size for text drawn into a annotation.
AIAPI AIErr(*	SetFontPreset )(AIAnnotatorDrawer *drawer, AIAnnotatorFont font)
	Sets the font for text drawn into a annotation, using preset font sizes.
AIAPI AIErr(*	SetFontByFontKey )(AIAnnotatorDrawer *drawer, AIFontKey font)
	Sets the font for text drawn into a annotation, using a font key.
AIAPI AIErr(*	SetFontByName )(AIAnnotatorDrawer *drawer, const ai::UnicodeString &name)
	Sets the font for text drawn into a annotation, by name.
AIAPI AIFontKey(*	GetFontKey )(AIAnnotatorDrawer *drawer)
	Retrieves the font key for the current font used to draw text into an annotation.
AIAPI void(*	GetFontName )(AIAnnotatorDrawer *drawer, ai::UnicodeString &name)
	Retrieves the name of the current font used to draw text into an annotation.
Clipping

AIAPI void(*	DefineClipStart )(AIAnnotatorDrawer *drawer)
	Starts the sequence for defining a clipping path in an annotation.
AIAPI void(*	DefineClipEnd )(AIAnnotatorDrawer *drawer)
	Starts the sequence for defining a clipping path in an annotation.
AIAPI void(*	ClearClip )(AIAnnotatorDrawer *drawer)
	Ends clipping in an annotation and removes the currently defined clipping path.
Miscellaneous

AIAPI AIErr(*	SetHighlightMode )(AIAnnotatorDrawer *drawer, AIBoolean highlightOn)
	Turns highlight blending mode on or off in an annotation.
AIAPI AIBoolean(*	GetHighlightMode )(AIAnnotatorDrawer *drawer)
	Retrieves the current highlight blending mode setting for an annotation.
AIAPI AIErr(*	DrawPNGImage )(AIAnnotatorDrawer drawer, const ai::uint8 inPNGImageData, ai::uint32 inDataSize, const AIPoint &topLeft)
	Draws a PNG Image in an annotation.
AIAPI AIErr(*	DrawPNGImageCentered )(AIAnnotatorDrawer drawer, const ai::uint8 inPNGImageData, ai::uint32 inDataSize, const AIRect &rect)
	Draws a PNG Image centered in a rectangle in an annotation.
AIAPI AIAGMPort (	GetAGMPort )(AIAnnotatorDrawer *drawer)
	Retrieves an AGM port for an annotation.
AIAPI void(*	ReleaseAGMPort )(AIAGMPort *&aiAGMPort)
	Releases an AGM port and sets the pointer to NULL.
AIAPI AIErr(*	GetPortOptions )(AIAnnotatorDrawer *drawer, ai::uint32 whichOptions, ai::uint32 &options)
	Retrieves the port options for an annotation.
AIAPI AIErr(*	SetPortOptions )(AIAnnotatorDrawer *drawer, ai::uint32 whichOptions, ai::uint32 options)
	Sets the port options for an annotation.
AIAPI AIErr(*	SetOpacity )(AIAnnotatorDrawer *drawer, AIReal opacity)
	Sets the opacity of an annotation.
AIAPI AIReal(*	GetOpacity )(AIAnnotatorDrawer *drawer)
	Retrieves the opacity of an annotation.

Detailed Description

The annotator drawer suite allows plug-ins to draw annotations into the document window that are not a part of the artwork.

Coordinates are in document view space.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIAnnotatorDrawerSuite and kAIAnnotatorDrawerVersion.

Member Data Documentation

AIAPI void(* AIAnnotatorDrawerSuite::ClearClip)(AIAnnotatorDrawer *drawer)

Ends clipping in an annotation and removes the currently defined clipping path.

Parameters:

drawer

The annotation drawer object.

See also:: DefineClipStart(), DefineClipEnd()

AIAPI void(* AIAnnotatorDrawerSuite::DefineClipEnd)(AIAnnotatorDrawer *drawer)

Starts the sequence for defining a clipping path in an annotation.

Subsequent drawing is clipped until the call to ClearClip(). Note that this function does not return an error code.

Parameters:

drawer

The annotation drawer object.

See also:: DefineClipStart()

AIAPI void(* AIAnnotatorDrawerSuite::DefineClipStart)(AIAnnotatorDrawer *drawer)

Starts the sequence for defining a clipping path in an annotation.

Everything drawn until the call to DefineClipEnd() is unioned into the clipping path, after which all drawing is clipped until the call to ClearClip(). Shapes drawn for clipping should generally be filled. Note that this function does not return an error code.

Parameters:

drawer

The annotation drawer object.

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawBezier)(AIAnnotatorDrawer *drawer, const AIPoint &start, const AIPoint pointSets[][3], ai::uint32 numPointSets, AIBoolean fill)

Draws cubic Bezier curves in an annotation by threading through a set of points.

Parameters:

	start	[in] The starting anchor point for the curve
	pointSets	[in] An array of sets of points describing the Bezier. The points in the inner array, p0, p1, and p2, have the following meaning: p0 exit control point for the previous anchor p1 entry control point for anchor p2 anchor point These are in the same order as for the PostScript CurveTo command.
	numPointSets	[in] The number of sets of points in the array.
	fill	True to fill with the current color, false for no fill.

See also:: SetColor()

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawEllipse)(AIAnnotatorDrawer *drawer, const AIRect &rect, AIBoolean fill)

Draws an ellipse bounded by the rectangle in an annotation.

Parameters:

	drawer	The annotation drawer object.
	rect	The rectangle dimensions.
	fill	True to fill with the current color, false for no fill.

See also:: SetColor()

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawLine)(AIAnnotatorDrawer *drawer, const AIPoint &start, const AIPoint &end)

Draws a line between two points in an annotation.

Parameters:

	drawer	The annotation drawer object.
	start	The starting point.
	end	The ending point.

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawPNGImage)(AIAnnotatorDrawer *drawer, const ai::uint8 *inPNGImageData, ai::uint32 inDataSize, const AIPoint &topLeft)

Draws a PNG Image in an annotation.

Parameters:

	drawer	The annotation drawer object.
	inPNGImageData	The raw PNG image data.
	topLeft	The point at which to draw the top left corner.

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawPNGImageCentered)(AIAnnotatorDrawer *drawer, const ai::uint8 *inPNGImageData, ai::uint32 inDataSize, const AIRect &rect)

Draws a PNG Image centered in a rectangle in an annotation.

Parameters:

	drawer	The annotation drawer object.
	inPNGImageData	The raw PNG image data.
	rect	The rectangle.

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawPolygon)(AIAnnotatorDrawer *drawer, const AIPoint points[], ai::uint32 numPoints, AIBoolean fill)

Draws a polygon in an annotation by connecting a set of points.

Parameters:

	drawer	The annotation drawer object.
	points	The array of points to connect.
	numPoints	The number of points in the array.
	fill	True to fill with the current color, false for no fill.

See also:: SetColor()

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawRect)(AIAnnotatorDrawer *drawer, const AIRect &rect, AIBoolean fill)

Draws a rectangle in an annotation.

Parameters:

	drawer	The annotation drawer object.
	rect	The rectangle dimensions.
	fill	True to fill with the current color, false for no fill.

See also:: SetColor()

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawText)(AIAnnotatorDrawer *drawer, const ai::UnicodeString &text, const AIPoint &bottomLeft)

Draws text into an annotation.

Parameters:

	drawer	The annotation drawer object.
	text	The text string.
	bottomLeft	The point at which to place the bottom left corner of the text.

AIAPI AIErr(* AIAnnotatorDrawerSuite::DrawTextAligned)(AIAnnotatorDrawer *drawer, const ai::UnicodeString &text, const AIHorizAlignment horizAlign, const AIVertAlignment vertAlign, const AIRect &rect)

Draws text into a rectangle in an annotation, with given alignment.

The text does not wrap.

Parameters:

	drawer	The annotation drawer object.
	text	The text string.
	horizAlign	The horizontal alignment of content.
	vertAlign	The vertical alignment of content.
	rect	The rectangle in which to draw.

AIAPI AIAGMPort*(* AIAnnotatorDrawerSuite::GetAGMPort)(AIAnnotatorDrawer *drawer)

Retrieves an AGM port for an annotation.

Note that this function returns a port object pointer, not an error code. You must call ReleaseAGMPort() when you are no longer using the port. Failure to release the port causes memory leaks.

Parameters:

drawer

The annotation drawer object.

AIAPI void(* AIAnnotatorDrawerSuite::GetColor)(AIAnnotatorDrawer *drawer, AIRGBColor &color)

Retrieves the current drawing color for an annotation.

Note that this function does not return an error code.

Parameters:

	drawer	The annotation drawer object.
	color	[out] A buffer in which to return the color.

AIAPI AIFontKey(* AIAnnotatorDrawerSuite::GetFontKey)(AIAnnotatorDrawer *drawer)

Retrieves the font key for the current font used to draw text into an annotation.

Note that this function returns a font-key object, not an error code.

Parameters:

drawer

The annotation drawer object.

Returns:: The font key.

AIAPI void(* AIAnnotatorDrawerSuite::GetFontName)(AIAnnotatorDrawer *drawer, ai::UnicodeString &name)

Retrieves the name of the current font used to draw text into an annotation.

Note that this function does not return an error code.

Parameters:

	drawer	The annotation drawer object.
	name	[out] A buffer in which to return the font name.

AIAPI AIReal(* AIAnnotatorDrawerSuite::GetFontSize)(AIAnnotatorDrawer *drawer)

Retrieves the font size for text drawn into a annotation.

Note that this function returns a numeric value, not an error code.

Parameters:

drawer

The annotation drawer object.

Returns:: The current font size, in document points.

AIAPI AIBoolean(* AIAnnotatorDrawerSuite::GetHighlightMode)(AIAnnotatorDrawer *drawer)

Retrieves the current highlight blending mode setting for an annotation.

Note that this function returns a Boolean value, not an error code.

Parameters:

drawer

The annotation drawer object.

Returns:: True if highlight mode is on.

AIAPI AIBoolean(* AIAnnotatorDrawerSuite::GetLineDashed)(AIAnnotatorDrawer *drawer)

Reports the current dashed-line drawing state for an annotation.

Note that this function returns a Boolean value, not an error code.

Parameters:

drawer

The annotation drawer object.

Returns:: True if dashed lines are on, false if they are off.

See also:: GetLineDashedEx()

AIAPI AIErr(* AIAnnotatorDrawerSuite::GetLineDashedEx)(AIAnnotatorDrawer *drawer, AIFloat dashData[], ai::int32 &numDashes)

Retrieves the dashing pattern for dashed-line drawing for an annotation.

Parameters:

	drawer	The annotation drawer object.
	dashData	[out] An array in which to return the dash and gap lengths, in document points.
	numDashes	[out] A buffer in which to return the number of entries in the dash array, in the range [1 to 12].

See also:: GetLineDashed()

AIAPI AIReal(* AIAnnotatorDrawerSuite::GetLineWidth)(AIAnnotatorDrawer *drawer)

Retrieves the line width for an annotation.

Note that this function returns a numeric value, not an error code.

Parameters:

drawer

The annotation drawer object.

Returns:: The width in document points.

AIAPI AIReal(* AIAnnotatorDrawerSuite::GetOpacity)(AIAnnotatorDrawer *drawer)

Retrieves the opacity of an annotation.

Note that this function returns a numeric value, not an error code.

Parameters:

drawer

The annotation drawer object.

Returns:: The opacity value in the range [0.0 to 1.0]. A value of 1 means fully opaque.

AIAPI AIErr(* AIAnnotatorDrawerSuite::GetPortOptions)(AIAnnotatorDrawer *drawer, ai::uint32 whichOptions, ai::uint32 &options)

Retrieves the port options for an annotation.

Currently, the only public port option is anti-aliasing mode, represented by the option constant AIAnnotatorPortOption::kAIOptionAAGraphics.

Parameters:

	drawer	The annotation drawer object.
	whichOptions	A mask for the option bits of interest, a logical OR of `AIAnnotatorPortOption` values.
	options	[out] A buffer in which to return the option value, a logical OR of `AIAnnotatorPortOption` values masked by the which-options mask.

AIAPI AIErr(* AIAnnotatorDrawerSuite::GetTextBounds)(AIAnnotatorDrawer *drawer, const ai::UnicodeString &text, AIPoint *location, AIBoolean useFontFallback, AIRect &bounds)

Finds the bounds of text if it were drawn in the current font at the current size.

Parameters:

	drawer	The annotation drawer object.
	text[in]	The text to be drawn.
	location	[in] A location in document view coordinates, for a relative result. Default is [0,0].
	useFontFallback	[in] Use system font if it is not possible to draw with current font.
	bounds	[out] A buffer in which to return the coordinates of the text boundary. If a location is not specified, top left is [0,0].

AIAPI void(* AIAnnotatorDrawerSuite::ReleaseAGMPort)(AIAGMPort *&aiAGMPort)

Releases an AGM port and sets the pointer to NULL.

Note that this function does not return an error code.

Parameters:

aiAGMPort

The port pointer.

AIAPI void(* AIAnnotatorDrawerSuite::SetColor)(AIAnnotatorDrawer *drawer, const AIRGBColor &color)

Sets the drawing color for an annotation.

Note that this function does not return an error code.

Parameters:

	drawer	The annotation drawer object.
	color	The new color.

AIAPI AIErr(* AIAnnotatorDrawerSuite::SetFontByFontKey)(AIAnnotatorDrawer *drawer, AIFontKey font)

Sets the font for text drawn into a annotation, using a font key.

Parameters:

	drawer	The annotation drawer object.
	font	The new font key.

AIAPI AIErr(* AIAnnotatorDrawerSuite::SetFontByName)(AIAnnotatorDrawer *drawer, const ai::UnicodeString &name)

Sets the font for text drawn into a annotation, by name.

Parameters:

	drawer	The annotation drawer object.
	name	The new font name. Interpreted as a PostScript font name; or, if none is found, a platform-encoded font name.

AIAPI AIErr(* AIAnnotatorDrawerSuite::SetFontPreset)(AIAnnotatorDrawer *drawer, AIAnnotatorFont font)

Sets the font for text drawn into a annotation, using preset font sizes.

Parameters:

	drawer	The annotation drawer object.
	font	The new font preset constant.

AIAPI void(* AIAnnotatorDrawerSuite::SetFontSize)(AIAnnotatorDrawer *drawer, const AIReal size)

Sets the font size for text drawn into a annotation.

Parameters:

	drawer	The annotation drawer object.
	size	The new font size, in document points.

AIAPI AIErr(* AIAnnotatorDrawerSuite::SetHighlightMode)(AIAnnotatorDrawer *drawer, AIBoolean highlightOn)

Turns highlight blending mode on or off in an annotation.

It is off by default. This mode provides extra visibility, like XOR drawing, but it cannot be used to erase previous marks drawn in highlight mode.

Parameters:

	drawer	The annotation drawer object.
	highlightOn	True to turn highlight mode on, false to turn it off.

AIAPI void(* AIAnnotatorDrawerSuite::SetLineDashed)(AIAnnotatorDrawer *drawer, AIBoolean dashed)

Turns dashed-line drawing on or off for an annotation.

Note that this function does not return an error code.

Parameters:

	drawer	The annotation drawer object.
	dashed	True to turn dashed lines on, false to turn them off.

See also:: SetLineDashedEx()

AIAPI AIErr(* AIAnnotatorDrawerSuite::SetLineDashedEx)(AIAnnotatorDrawer *drawer, AIFloat dashData[], ai::int32 numDashes)

Sets the dashing pattern for dashed-line drawing for an annotation.

Parameters:

	drawer	The annotation drawer object.
	dashData	The array of dash and gap lengths, in document points.
	numDashes	The number of entries in the dash array, in the range [1 to 12].

See also:: SetLineDashed()

AIAPI void(* AIAnnotatorDrawerSuite::SetLineWidth)(AIAnnotatorDrawer *drawer, const AIReal newWidth)

Sets the line width for an annotation.

When not explicitly set, the line width is one document point.

Parameters:

	drawer	The annotation drawer object.
	newWidth	The new width in document points.

AIAPI AIErr(* AIAnnotatorDrawerSuite::SetOpacity)(AIAnnotatorDrawer *drawer, AIReal opacity)

Sets the opacity of an annotation.

To avoid transparency buildup, clip drawing to invalidation rectangles.

Parameters:

	drawer	The annotation drawer object.
	opacity	The new opacity value in the range [0.0 to 1.0]. A value of 1 means fully opaque.

AIAPI AIErr(* AIAnnotatorDrawerSuite::SetPortOptions)(AIAnnotatorDrawer *drawer, ai::uint32 whichOptions, ai::uint32 options)

Sets the port options for an annotation.

Currently, the only public port option is anti-aliasing mode, represented by the option constant AIAnnotatorPortOption::kAIOptionAAGraphics.

Parameters:

	drawer	The annotation drawer object.
	whichOptions	A mask for the option bits of interest, a logical OR of `AIAnnotatorPortOption` values.
	options	The new options value, a logical OR of `AIAnnotatorPortOption` values masked by the which-options mask.

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

AIAnnotatorDrawer.h

AIAnnotatorDrawerSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIAnnotatorDrawerSuite Struct Reference
[API Suite List]