ai::DocumentUtils Namespace Reference

Classes
class	ArtScaler
Functions
AIReal	GetDocumentScale ()
	For each document with document scale factor X, each object's dimension have to multiplied by X to get the correct dimensions of the object in UI For example, if document scale factor is X, then a 10x10 rectangle will actually will be displayed as (10*X)x(10*X) rectangle in UI Geting the scale associated with the current document.
AIRealMatrix	GetTransformMatrixForScaleFactorFromReference (const AIReal &scaleFactor, const AIRealPoint &referencePoint)
	Getting the transform matrix for converting the user defind artworks to tranform to documents with specified scale factor from a given reference point.
AIRealMatrix	GetTransFormMatrixForScaleFactor (const AIReal &scaleFactor)
	Getting the transform matrix for converting the user defind artworks to tranform to documents with specified scale factor.
AIRealMatrix	GetTransformMatrixForDocumentScaleFromReference (const AIRealPoint &referencePoint)
	Getting the transform matrix for converting the user defind artworks to tranform to documents with scale factor greater than 1 from a given reference point.
AIRealMatrix	GetTransFormMatrixForDocumentScale ()
	Getting the transform matrix for converting the user defind artworks to tranform to documents with scale factor greater than 1.
void	ApplyDocumentScaleToAIReal (const AIReal &inReal, AIReal &outReal)
	Converting the value of AIReal to scaled coordinate System.
void	DropDocumentScaleFromAIReal (const AIReal &inReal, AIReal &outReal)
	Converting the value of AIReal to scaled coordinate System.
template<typename Rect >
void	ApplyScaleToRect (const Rect &inRect, Rect &outRect, const AIReal scale)
	Multiply the coordinates of the AIRealRect with given scale value.
template<typename Rect >
void	ApplyDocumentScaleToRect (const Rect &inRect, Rect &outRect)
	Converting the coordinates of the AIRealRect to scaled coordinate System.
template<typename Point >
void	ApplyDocumentScaleToPoint (const Point &inPoint, Point &outPoint)
	Converting the coordinates of the AIPoint to scaled coordinate System.
template<typename Rect >
void	DropDocumentScaleFromRect (const Rect &inRect, Rect &outRect)
	Converting the coordinates of the scaled Rect to unscaled coordinate System.
template<typename Point >
void	DropDocumentScaleFromPoint (const Point &inPoint, Point &outPoint)
	Converting the coordinates of the AIPoint to scaled coordinate System.

---

Function Documentation

void ai::DocumentUtils::ApplyDocumentScaleToAIReal	(	const AIReal &	inReal,
		AIReal &	outReal
	)

Converting the value of AIReal to scaled coordinate System.

Parameters:

	inReal	AIReal in unscaled corrdinate system.
	outReal	[out] A buffer in which to return the cooresponding value in scaled coordinate system

template<typename Point >

void ai::DocumentUtils::ApplyDocumentScaleToPoint	(	const Point &	inPoint,
		Point &	outPoint
	)			[inline]

Converting the coordinates of the AIPoint to scaled coordinate System.

Parameters:

	inPoint	point with coordinates in unscaled corrdinate system.
	outPoint	[out] A buffer in which to return the cooresponding coordinates in scaled coordinate system

References GetDocumentScale().

template<typename Rect >

void ai::DocumentUtils::ApplyDocumentScaleToRect	(	const Rect &	inRect,
		Rect &	outRect
	)			[inline]

Converting the coordinates of the AIRealRect to scaled coordinate System.

Parameters:

	inRect	Rectangle with coordinates in unscaled coordinate system.
	outRect	[out] A buffer in which to return the corresponding coordinates in scaled coordinate system

References ApplyScaleToRect(), and GetDocumentScale().

template<typename Rect >

void ai::DocumentUtils::ApplyScaleToRect	(	const Rect &	inRect,
		Rect &	outRect,
		const AIReal	scale
	)			[inline]

Multiply the coordinates of the AIRealRect with given scale value.

Parameters:

	inRect	Rectangle with coordinates in unscaled coordinate system.
	outRect	[out] A buffer in which to return the corresponding coordinates in scaled coordinate system
	scale	Input scale value that will be applied to coordinates of Rect

Referenced by ApplyDocumentScaleToRect().

void ai::DocumentUtils::DropDocumentScaleFromAIReal	(	const AIReal &	inReal,
		AIReal &	outReal
	)

Converting the value of AIReal to scaled coordinate System.

Parameters:

	inReal	AIReal in scaled corrdinate system.
	outReal	[out] A buffer in which to return the cooresponding value in unscaled coordinate system

template<typename Point >

void ai::DocumentUtils::DropDocumentScaleFromPoint	(	const Point &	inPoint,
		Point &	outPoint
	)			[inline]

Converting the coordinates of the AIPoint to scaled coordinate System.

Parameters:

	inPoint	point with coordinates in scaled corrdinate system.
	outPoint	[out] A buffer in which to return the cooresponding coordinates in unscaled coordinate system

References GetDocumentScale().

template<typename Rect >

void ai::DocumentUtils::DropDocumentScaleFromRect	(	const Rect &	inRect,
		Rect &	outRect
	)			[inline]

Converting the coordinates of the scaled Rect to unscaled coordinate System.

Parameters:

	inRect	Rectangle with coordinates in scaled corrdinate system.
	outRect	[out] A buffer in which to return the cooresponding coordinates in unscaled coordinate system

References GetDocumentScale().

AIReal ai::DocumentUtils::GetDocumentScale

(

)

For each document with document scale factor X, each object's dimension have to multiplied by X to get the correct dimensions of the object in UI For example, if document scale factor is X, then a 10x10 rectangle will actually will be displayed as (10*X)x(10*X) rectangle in UI Geting the scale associated with the current document.

Parameters:

docScale

[out] A buffer in which to return the scale factor corresponding to the current document. it is a wrapper over AIDocumentSuite::GetDocumentScale() and asserts if no document is present.

Referenced by ApplyDocumentScaleToPoint(), ApplyDocumentScaleToRect(), DropDocumentScaleFromPoint(), and DropDocumentScaleFromRect().

AIRealMatrix ai::DocumentUtils::GetTransFormMatrixForDocumentScale

(

)

Getting the transform matrix for converting the user defind artworks to tranform to documents with scale factor greater than 1.

Parameters:

[out]

returns

tranformation matrix for scale factor of the current document about the Canvas center point

AIRealMatrix ai::DocumentUtils::GetTransformMatrixForDocumentScaleFromReference

(

const AIRealPoint &

referencePoint

)

Getting the transform matrix for converting the user defind artworks to tranform to documents with scale factor greater than 1 from a given reference point.

Parameters:

[in]	reference	point from which transformation is required
[out]	returns	tranformation matrix for scale factor of the current document about the given reference point

AIRealMatrix ai::DocumentUtils::GetTransFormMatrixForScaleFactor

(

const AIReal &

scaleFactor

)

Getting the transform matrix for converting the user defind artworks to tranform to documents with specified scale factor.

Parameters:

[out]

returns

tranformation matrix for scale factor of the current document about the Canvas center point

AIRealMatrix ai::DocumentUtils::GetTransformMatrixForScaleFactorFromReference	(	const AIReal &	scaleFactor,
		const AIRealPoint &	referencePoint
	)

Getting the transform matrix for converting the user defind artworks to tranform to documents with specified scale factor from a given reference point.

Parameters:

[in]	reference	point from which transformation is required
[out]	returns	tranformation matrix for scale factor of the current document about the given reference point