InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IDynamicTrackerData Class Referenceabstract
Inheritance diagram for IDynamicTrackerData:
IPMUnknown

Public Types

enum  TrackingState {
  kNotTracking, kBeginTracking, kContinueTracking, kEndTracking,
  kAbortTracking
}
 
enum  TrackingEffect {
  kAffectsNone = 0, kAffectsX = 1, kAffectsY = 2, kAffectsXY = kAffectsX | kAffectsY,
  kAffectsW = 4, kAffectsXW = kAffectsX | kAffectsW, kAffectsH = 8, kAffectsYH = kAffectsY | kAffectsH,
  kAffectsXYW = kAffectsXY | kAffectsW, kAffectsXYH = kAffectsXY | kAffectsH, kAffectsWH = kAffectsW | kAffectsH, kAffectsXYWH = kAffectsXY | kAffectsWH,
  kAffectsL = 16, kAffectsWHL = kAffectsWH | kAffectsL, kAffectsXYWHL = kAffectsXY | kAffectsWH | kAffectsL, kAffectsD1 = kAffectsL,
  kAffectsXYL = kAffectsXY | kAffectsL, kAffectsXYD1 = kAffectsXYL, kAffectsD2 = 32, kAffectsXYD2 = kAffectsXY | kAffectsD2,
  kAffectsDeltaX = 64, kAffectsDeltaY = 128, kAffectsDeltaXDeltaY = kAffectsDeltaX | kAffectsDeltaY, kAffectsXYDeltaX = kAffectsXY | kAffectsDeltaX,
  kAffectsXYDeltaY = kAffectsXY | kAffectsDeltaY, kAffectsXYDeltaXDeltaY = kAffectsXY | kAffectsDeltaX | kAffectsDeltaY, kMarqueeSelection = 256, kAffectsScaleX = 512,
  kAffectsScaleY = 1024, kAffectsSkewAngle = 2048, kAffectsRotationAngle = 4096, kAffectsTransform = kAffectsScaleX | kAffectsScaleY | kAffectsSkewAngle | kAffectsRotationAngle,
  kUnknown = 32768
}
 

Public Member Functions

virtual void NotifyBeginTracking (const PBPMPoint &startPoint, const TrackingEffect &effect)=0
 
virtual void NotifyContinueTracking (const PBPMPoint &startPoint, const PBPMPoint &endPoint, const TrackingEffect &effect)=0
 
virtual void NotifyContinueTracking (const PBPMPoint &startPoint, const PBPMPoint &middlePoint, const PBPMPoint &endPoint, const TrackingEffect &effect)=0
 
virtual void NotifyEndTracking (const PBPMPoint &startPoint, const PBPMPoint &endPoint, const TrackingEffect &effect)=0
 
virtual PBPMPoint GetStartPoint () const =0
 
virtual PBPMPoint GetEndPoint () const =0
 
virtual PBPMPoint GetMiddlePoint () const =0
 
virtual TrackingState GetTrackingState () const =0
 
virtual TrackingEffect GetTrackingEffect () const =0
 
virtual void EnableGridMode (bool enabled)=0
 
virtual void SetRows (int32 rows)=0
 
virtual void SetColumns (int32 columns)=0
 
virtual void SetInsets (const PMReal &left, const PMReal &top, const PMReal &right, const PMReal &bottom)=0
 
virtual void SetHorizontalSpacing (const PMReal &horzSpace)=0
 
virtual void SetVerticalSpacing (const PMReal &vertSpace)=0
 
virtual void SetGridBounds (const PMRect &bounds)=0
 
virtual bool IsGridModeEnabled () const =0
 
virtual int32 GetRows () const =0
 
virtual int32 GetColumns () const =0
 
virtual const PMRect & GetInsets () const =0
 
virtual PMReal GetHorizontalSpacing () const =0
 
virtual PMReal GetVerticalSpacing () const =0
 
virtual const PMRect & GetGridBounds () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual void IDynamicTrackerData::EnableGridMode (bool enabled)
pure virtual

Methods for grid/contact sheet creation when using the creation tools.EnableGridMode is called to enable/disable the creation of grids when using tools such as the Rectangle tool.

Parameters
enabled[IN]: true to enable grid mode, false to disable
virtual int32 IDynamicTrackerData::GetColumns () const
pure virtual

GetColumns

Returns
the number of columns in the grid.
virtual const PMRect& IDynamicTrackerData::GetGridBounds () const
pure virtual

GetGridBounds

Returns
the bounding box of the grid
virtual PMReal IDynamicTrackerData::GetHorizontalSpacing () const
pure virtual

GetHorizontalSpacing

Returns
horizontal spacing between columns
virtual const PMRect& IDynamicTrackerData::GetInsets () const
pure virtual

GetInsets

Returns
the left, top, right and bottoms inset values as a rectangle
virtual int32 IDynamicTrackerData::GetRows () const
pure virtual

GetRows

Returns
the number of rows in the grid.
virtual PMReal IDynamicTrackerData::GetVerticalSpacing () const
pure virtual

GetVerticalSpacing

Returns
vertical spacing between rows
virtual bool IDynamicTrackerData::IsGridModeEnabled () const
pure virtual

IsGridModeEnabled

Returns
whether or not grid mode is active
virtual void IDynamicTrackerData::SetColumns (int32 columns)
pure virtual

Set the number of columns in the grid.

Parameters
columns[IN]: the number of columns.
virtual void IDynamicTrackerData::SetHorizontalSpacing (const PMReal & horzSpace)
pure virtual

Set the amount of horizontal spacing between columns.

Parameters
horzSpace[IN]: horizontal spacing.
virtual void IDynamicTrackerData::SetInsets (const PMReal & left,
const PMReal & top,
const PMReal & right,
const PMReal & bottom 
)
pure virtual

Set the Insets. Typically zero.

Parameters
left[IN]: left inset.
top[IN]: top inset.
right[IN]: right inset.
bottom[IN]: bottom inset.
virtual void IDynamicTrackerData::SetRows (int32 rows)
pure virtual

Set the number of rows in the grid.

Parameters
rows[IN]: the number of rows.
virtual void IDynamicTrackerData::SetVerticalSpacing (const PMReal & vertSpace)
pure virtual

Set the amount of vertical spacing between rows.

Parameters
horzSpace[IN]: vertical spacing.