InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
WaveTracker Class Reference

#include <WaveTracker.h>

Inheritance diagram for WaveTracker:
CPathCreationTrackerCTrackerITrackerIPMUnknownSawWaveTrackerSineWaveTracker

Public Member Functions

 WaveTracker (IPMUnknown *boss)
 
 ~WaveTracker ()
 
virtual void ShiftConstrainPoint (PMPoint &convertedPoint)
 
virtual void SetBoundingBox (const UIDRef &newItem, const UIDRef &parent, const PMPointList &points)
 
- Public Member Functions inherited from CPathCreationTracker
 CPathCreationTracker (IPMUnknown *boss)
 
virtual ~CPathCreationTracker ()
 
virtual bool16 BeginTracking (IEvent *theEvent)
 
virtual void ContinueTracking (const PBPMPoint &where, bool16 mouseDidMove)
 
virtual bool16 EndTracking (IEvent *theEvent)
 
virtual void AbortTracking (IEvent *theEvent)
 
- Public Member Functions inherited from CTracker
 CTracker (IPMUnknown *boss)
 
virtual void SetupTracker (IControlView *theControlView, ISnapTo *theSnapper=NULL, IItemContext *context=NULL)
 
virtual IControlViewQueryControlView () const
 
virtual bool16 IsEnabled ()
 
virtual bool16 IsTracking ()
 
virtual void EnableTracking ()
 
virtual void DisableTracking ()
 
virtual void HandleContinueTracking (const GSysPoint &where)
 
virtual void TimerMessage (int32 flags)
 
virtual bool16 WantTimer (ClassID trackerTimerBoss)
 
- Public Member Functions inherited from ITracker
void SetupTracker (IControlView *theControlView)
 
void SetupSpecialTracker (IControlView *theControlView, ISnapTo *theSnapper, IItemContext *context)
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Protected Member Functions

void Transform (const PMPoint &endPoint, const PMReal pathLength, IPathGeometry *pathGeometry)
 
- Protected Member Functions inherited from CPathCreationTracker
virtual void CleanupTracking ()
 
virtual CursorOptions GetCursorOption (void) const
 
virtual void HandleMove (PMPoint &where)
 
virtual PMPoint AutoScroll (const PMPoint &scrollBy, const PMPoint &scrolledPoint)
 
virtual void MakePath (const PMPoint &startPt, const PMPoint &endPoint, IPathGeometry *pathGeometry)
 
virtual bool16 MovedMinimumDistance (const PBPMPoint &newLocation)
 
virtual bool16 IsGraphicFrame ()
 
virtual void ProcessAdditionalCreationCommands (const UIDRef &newItem, const UIDRef &parent, const PMPointList &points, IPlaceBehavior::eAfterPlace afterPlace)
 
virtual UIDRef CreatePageItem (const UIDRef &parent, const PMPointList &points, const IEvent &theEvent, IPlaceBehavior::eAfterPlace *afterPlace=nil)
 
virtual void AddToHierarchy (const UIDRef &parent, const UIDRef &newItem)
 
virtual void ProcessAdditionalSelectionCommands (const UIDRef &newItem)
 
virtual void ProcessAddToSelectionCommand (IControlView *view, const UIDRef &newItem)
 
virtual void CompletelyCreateItem (IEvent *theEvent)
 
virtual bool16 SufficientSize (const PMPointList &points)
 
virtual void ConvertToPasteboardConstrained (PMPoint thePoint, PMPoint &convertedPoint)
 
virtual void ConvertToPasteboardConstrained (GSysPoint thePoint, PMPoint &convertedPoint)
 
virtual void SetUpParentTransforms (PMPoint *endPoint)
 
virtual UIDRef GetParent ()
 
virtual void CheckSmartDimensions (PBPMPoint &endPoint, PBPMPoint &startPoint, SnapType &snapType, const IControlView *view)
 
virtual Geometry::BoundsKind GetPathCreationBoundsKind ()
 
- Protected Member Functions inherited from CTracker
virtual void Initialize (IEvent *theEvent)
 
virtual bool16 DoBeginTracking (IEvent *theEvent)
 
virtual bool16 DoEndTracking (IEvent *theEvent)
 
virtual void NotifyBeginTracking (const PMPoint &startPt, IDynamicTrackerData::TrackingEffect effect=IDynamicTrackerData::kUnknown)
 
virtual void NotifyContinueTracking (const PMPoint &startPt, const PMPoint &endPoint, IDynamicTrackerData::TrackingEffect effect=IDynamicTrackerData::kUnknown)
 
virtual void NotifyEndTracking (const PMPoint &startPt, const PMPoint &endPoint, IDynamicTrackerData::TrackingEffect effect=IDynamicTrackerData::kUnknown)
 
virtual
IDynamicTrackerData::TrackingEffect 
GetTrackingEffect (IDynamicTrackerData::TrackingState state)
 
virtual void PushEventHandler ()
 
virtual void PopEventHandler ()
 
virtual bool16 WantsToAutoScroll (const PMPoint &currentPoint)
 
virtual void GlobalToPasteboard (const GSysPoint &thePoint, PBPMPoint &convertedPoint)
 
virtual PMPoint PasteboardToGlobal (const PBPMPoint &pbPoint)
 
virtual IPanoramaQueryPanorama (IControlView *pView) const
 
virtual void DisableUpdates ()
 
virtual void EnableUpdates ()
 
void DeselectAllItems ()
 
virtual void ComputeAdjustedPoint (PMPoint &adjustedPoint)
 
void InitializeModalCursor ()
 
void ChangeModalCursor (const CursorSpec &spec)
 
void UpdateModalCursor ()
 
void ReleaseModalCursor ()
 
virtual uint32 GetMouseMoveDelay ()
 
virtual uint32 GetMouseSteadyDelay ()
 
virtual bool16 AdjustPoint (PBPMPoint &point)
 
void StartTimer (ClassID trackerTimerBoss, uint32 milliSeconds, uint32 mouseMoveDelay=kDefaultMouseMoveDelay, uint32 mouseSteadyDelay=kDefaultMouseSteadyDelay)
 
void StopTimer (ClassID trackerTimerBoss)
 
bool16 GetTimerFlags ()
 
void SetTimerFlags (int32 flags)
 
uint32 GetElapsedTime ()
 
virtual IDataBaseGetTrackingDataBase () const
 

Additional Inherited Members

- Public Types inherited from CPathCreationTracker
enum  CursorOptions {
  kDefaultCursor = 0, kShowWidthHeight, kShowXPosition, kShowYPosition,
  kShowXYPosition, kShowLineLength, kShowScale
}
 
- Static Protected Member Functions inherited from CTracker
static void DeactivatePageItem ()
 
- Protected Attributes inherited from CPathCreationTracker
ClassID fClassID
 
PMPoint fStartPnt
 
PMPoint fStartGlobalPt
 
PMRect fPasteBoardBoundaries
 
PMRect fPasteBoardBoundsSpreadCoordinates
 
bool16 fShiftKeyPressed
 
bool16 fShownFirstTime
 
bool16 fOptionAltKeyPressed
 
bool16 fCmdCtrlKeyPressed
 
bool16 fCreatingFromCenter
 
PMMatrix fSpreadToPasteboardMatrix
 
PMMatrix fPasteboardToSpreadMatrix
 
PMMatrix fTransformMatrix
 
PMMatrix fBackTransformMatrix
 
IAbortableCmdSeqfTrackerSequence
 
PMRect fGraphicBBox
 
bool32 fCreateMultiple
 
int32 fRows
 
int32 fColumns
 
- Static Protected Attributes inherited from CPathCreationTracker
static PMReal fHSpacing
 
static PMReal fVSpacing
 

Detailed Description

Base implementation for the trackers in this plug-in. Functionality common to all trackers chould be added here.

Constructor & Destructor Documentation

WaveTracker::WaveTracker (IPMUnknownboss)

Constructor.

WaveTracker::~WaveTracker ()

Destructor

Member Function Documentation

void WaveTracker::SetBoundingBox (const UIDRefnewItem,
const UIDRefparent,
const PMPointListpoints 
)
virtual

Adjusts the bounding box of the page item. The CPathCreationTracker implementation of SetBoundingBox assumes the page item is created within the bounds of the box dragged by the mouse. Our wave paths may extend above or below this box. So we override this method and adjust the bounds to the bounding box of our wave.

Parameters
newItemthe new item that is created by the wave tool
parentthe new item's parent
pointsdefault bounds described by point list containing top left and bottom right points.

Reimplemented from CPathCreationTracker.

void WaveTracker::ShiftConstrainPoint (PMPointconvertedPoint)
virtual

When the shift key is pressed constrain the line along which the user is dragging to be a multiple of 45 degrees.

Parameters
convertedPointthe resulting location of the mouse when the point is constrained.

Reimplemented from CPathCreationTracker.

void WaveTracker::Transform (const PMPointendPoint,
const PMReal pathLength,
IPathGeometrypathGeometry 
)
protected

Transforms the supplied path.

  • translates the origin to the point at which the user did mouse down
  • rotates the axis to align with the line on which the user is dragging the mouse
  • scales proportional to distance between start point and end point
Parameters
endPointthe last point in the path to be transformed.
pathLengththe length of the path to be transformed
pathGeometrythe path to be transformed.