InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CGeometry Class Referenceabstract
Inheritance diagram for CGeometry:
IGeometryIPMUnknown

Public Member Functions

 CGeometry (IPMUnknown *boss)
 
virtual PMRect GetStrokeBoundingBox () const
 
virtual PMRect GetStrokeBoundingBox (const PMMatrix &theMatrix) const
 
virtual ErrorCode SetStrokeBoundingBox (const PMRect &newBBox)
 
virtual ErrorCode SetStrokeBoundingBox (const PMMatrix &theMatrix, const PMRect &newBBox)
 
virtual PMRect GetPathBoundingBox () const =0
 
virtual PMRect GetPathBoundingBox (const PMMatrix &theMatrix) const =0
 
virtual ErrorCode SetPathBoundingBox (const PMRect &newBBox)=0
 
virtual ErrorCode SetPathBoundingBox (const PMMatrix &theMatrix, const PMRect &newBBox)=0
 
virtual PMReal GetStrokeProportion () const
 
virtual PMReal GetPathProportion () const
 
- Public Member Functions inherited from IGeometry
PMRect GetBoundingBox (Geometry::BoundsKind kind, const PMMatrix &theMatrix) const
 
PMRect GetBoundingBox (Geometry::BoundsKind kind) const
 
ErrorCode SetBoundingBox (Geometry::BoundsKind kind, const PMRect &newBBox)
 
ErrorCode SetBoundingBox (Geometry::BoundsKind kind, const PMMatrix &theMatrix, const PMRect &newBBox)
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Additional Inherited Members

- Public Types inherited from IGeometry
enum  { kDefaultIID = IID_IGEOMETRY }
 

Member Function Documentation

virtual PMRect CGeometry::GetPathBoundingBox () const
pure virtual

Get the bounding box that exclude stroke. Bounding box returned is in inner coordinates.

Returns
PMRect the result bounding box.

Implements IGeometry.

virtual PMRect CGeometry::GetPathBoundingBox (const PMMatrixtheMatrix) const
pure virtual

Get the bounding box that exclude stroke but with no transformations done.

Parameters
theMatrix[In] parameter used to transform the BBox before returning. For example, if you want a PasteBoardBBox, pass in an InnerToPasteboard Matrix.
Returns
PMRect the result bounding box.

Implements IGeometry.

virtual PMReal CGeometry::GetPathProportion () const
virtual

Get the proportion(width/height) excluding stroke. This is a helper method for constraining.

Returns
PMReal by default this is the width of the bounding box divided by its height.

Implements IGeometry.

virtual PMRect CGeometry::GetStrokeBoundingBox () const
virtual

Get the bounding box that include stroke but with no transformations done. Bounding box returned is in inner coordinates.

Returns
PMRect the result bounding box.

Implements IGeometry.

virtual PMRect CGeometry::GetStrokeBoundingBox (const PMMatrixtheMatrix) const
virtual

Get the bounding box that include stroke.

Parameters
theMatrix[In] parameter used to transform the BBox before returning. For example, if you want a PasteBoardBBox, pass in an InnerToPasteboard Matrix.
Returns
PMRect the result bounding box.

Implements IGeometry.

virtual PMReal CGeometry::GetStrokeProportion () const
virtual

Get the proportion(width/height) including stroke. This is a helper method for constraining.

Returns
PMReal by default this is the width of the bounding box divided by its height.

Implements IGeometry.

virtual ErrorCode CGeometry::SetPathBoundingBox (const PMRectnewBBox)
pure virtual

Set the bounding box without stroke in inner coordinates.

Parameters
newBBox[In] parameter used to set the new bounding box.
whichAction[In] parameter used to specify the action for children when doing this operation.
Returns
ErrorCode indicates the result of operation.

Implements IGeometry.

virtual ErrorCode CGeometry::SetPathBoundingBox (const PMMatrixtheMatrix,
const PMRectnewBBox 
)
pure virtual

Set the bounding box without stroke.

Parameters
theMatrix[In] parameter that may change the transform of the item depending on the implementation of IGeometry
newBBox[In] parameter used to set the new bounding box.
whichAction[In] parameter used to specify the action for children when doing this operation.
Returns
ErrorCode indicates the result of operation.

Implements IGeometry.

virtual ErrorCode CGeometry::SetStrokeBoundingBox (const PMRectnewBBox)
virtual

Set the bounding box with stroke in inner coordinates.

Parameters
newBBox[In] parameter used to set the new bounding box.
whichAction[In] parameter used to specify the action for children when doing this operation.
Returns
ErrorCode indicates the result of operation.

Implements IGeometry.

virtual ErrorCode CGeometry::SetStrokeBoundingBox (const PMMatrixtheMatrix,
const PMRectnewBBox 
)
virtual

Set the bounding box with stroke.

Parameters
theMatrix[In] parameter that may change the transform of the item depending on the implementation of IGeometry
newBBox[In] parameter used to set the new bounding box.
whichAction[In] parameter used to specify the action for children when doing this operation.
Returns
ErrorCode indicates the result of operation.

Implements IGeometry.