InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IRefPointUtils Class Referenceabstract

#include <IRefPointUtils.h>

Inheritance diagram for IRefPointUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IREFPOINTUTILS }
 

Public Member Functions

virtual PBPMPoint CalculateReferencePoint_1 (IReferencePointData::ReferencePointPosition position, const PMPolygon4 &bounds)=0
 
virtual PBPMPoint CalculateReferencePoint_2 (IReferencePointData::ReferencePointPosition position, const UIDList &items, PBPMRect *referenceFrame, const Geometry::BoundsKind *pUseStroke, const Transform::CoordinateSpace *coordinateSpace)=0
 
PBPMPoint CalculateReferencePoint_3 (IReferencePointData::ReferencePointPosition position, const UIDList &items)
 
virtual
IReferencePointData::ReferencePointPosition 		MapPointIndexToReferencePoint (PMRect::PointIndex index)=0
 
virtual PMRect::PointIndex MapReferencePointToPointIndex (IReferencePointData::ReferencePointPosition position)=0
 
virtual Transform::TransformOrigin RefPositionToTransformOrigin (IReferencePointData::ReferencePointPosition position)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Utility interface for functions that computing reference points. The reference point has several components: a pasteboard coordinate, and a position (see .h for ReferencePointPosition enum). The reference point is used for displaying information in the transform panel for selected page item coordinates, and as a reference point for certain commands (such as rotation, which is done around a reference point).

See Also
IRefPointUIUtils.h
ReferencePointPosition

Member Function Documentation

virtual PBPMPoint IRefPointUtils::CalculateReferencePoint_1 (IReferencePointData::ReferencePointPosition position,
const PMPolygon4 & bounds 
)
pure virtual

Returns the reference point in pasteboard coordinates for the specified bounds based on the position.

Parameters
position[IN] is one of IReferencePointData::ReferencePointPosition. See .h
bounds[IN] is the bounds, typically of the selection.
Returns
the reference point.
virtual PBPMPoint IRefPointUtils::CalculateReferencePoint_2 (IReferencePointData::ReferencePointPosition position,
const UIDList & items,
PBPMRect * referenceFrame,
const Geometry::BoundsKind * pUseStroke,
const Transform::CoordinateSpace * coordinateSpace 
)
pure virtual

Returns the reference point in pasteboard coordinates for the specified items in the list based on the position.

Parameters
position[IN] is one of IReferencePointData::ReferencePointPosition. See .h
items[IN] the list of items.
referenceFrame[OUT] if not nil, the parent's rect bound is returned.
pUseStroke[IN] if not nil, it use this setting to calculate the reference point. If true, the stroke bounds are used. Otherwise the path bound is used. If nil, the current global setting from ITransformPanelPrefs is used.
Returns
the reference point.
See Also
ITransformPanelPrefs.h
GetShowStrokeBounds
virtual IReferencePointData::ReferencePointPosition IRefPointUtils::MapPointIndexToReferencePoint (PMRect::PointIndex index)
pure virtual

Returns the reference position given a rect point index.

Parameters
index[IN] is the point index and is one of PMRect::PointIndex. See .h
Returns
the reference point position and is one of IReferencePointData::ReferencePointPosition. See .h
virtual PMRect::PointIndex IRefPointUtils::MapReferencePointToPointIndex (IReferencePointData::ReferencePointPosition position)
pure virtual

Returns the point index position given a reference point position.

Parameters
position[IN] is the reference position and is one of IReferencePointData::ReferencePointPosition. See .h
Returns
the point index and is one of PMRect::PointIndex. See .h
virtual Transform::TransformOrigin IRefPointUtils::RefPositionToTransformOrigin (IReferencePointData::ReferencePointPosition position)
pure virtual

Converts a reference point position to its equivalent TransformOrigin. e.g. IReferencePointData::kTopLeft converts to Transform::LeftTopLocation()

Parameters
position[IN] is the reference position and is one of IReferencePointData::ReferencePointPosition. See .h
Returns
TransformOrigin to match. See .h