ISplineState Class Reference

#include <ISplineState.h>

Inheritance diagram for ISplineState:

Public Types
enum	{ kDefaultIID = IID_ISPLINESTATE }
enum	SplineState { kOff = 0x0000, kCreation = 0x0001, kMotion = 0x0002, kCreationAndMotion = (kCreation | kMotion) }

Public Member Functions
virtual void	SetState (SplineState newState)=0
virtual ISplineState::SplineState	GetState () const =0
virtual void	SetPageItem (const UIDRef &pageitem)=0
virtual const UIDRef &	GetPageItem () const =0
virtual void	SetMotionPageItem (const UIDRef &pageitem)=0
virtual void	SetMotionOwnerPageItem (const UIDRef &pageitem)=0
virtual const UIDRef &	GetMotionPageItem () const =0
virtual const UIDRef &	GetMotionOwnerPageItem () const =0
virtual void	SetPathAndPointIndex (int32 pathIndex, int32 pointIndex)=0
virtual int32	GetPathIndex () const =0
virtual int32	GetPointIndex () 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

Detailed Description

Stores whether a spline is currently in creation or motion editing mode within a document workspace and the active path point.

Member Enumeration Documentation

enum ISplineState::SplineState

Values for spline editing.

Enumerator
kCreation	Not editing a spline
kMotion	In process of creating a new spline, or editing a spline
kCreationAndMotion	In process of editing a motion path

Member Function Documentation

virtual const UIDRef& ISplineState::GetMotionOwnerPageItem ( ) const

pure virtual

Returns the UIDRef of the owner page item that the motion item refers to

virtual const UIDRef& ISplineState::GetMotionPageItem ( ) const

pure virtual

Returns the UIDRef of the motion page item being created/edited

virtual const UIDRef& ISplineState::GetPageItem ( ) const

pure virtual

Returns the UIDRef of the page item being created/edited

virtual int32 ISplineState::GetPathIndex ( ) const

pure virtual

Get the current path index

virtual int32 ISplineState::GetPointIndex ( ) const

pure virtual

Get the current point index

virtual ISplineState::SplineState ISplineState::GetState ( ) const

pure virtual

Returns spline state for the document

virtual void ISplineState::SetMotionOwnerPageItem ( const UIDRef &  pageitem )

pure virtual

Sets the UIDRef of the owner page item that the motion page item refers to

virtual void ISplineState::SetMotionPageItem ( const UIDRef &  pageitem )

pure virtual

Sets the UIDRef of the motion page item being created/edited

virtual void ISplineState::SetPageItem ( const UIDRef &  pageitem )

pure virtual

Sets the UIDRef of the item being created/edited

virtual void ISplineState::SetPathAndPointIndex ( int32  pathIndex, int32  pointIndex  )

pure virtual

Sets the current path and point index from which to continue creation

virtual void ISplineState::SetState ( SplineState  newState )

pure virtual

Signals that the document (or whatever item this interface is on) is in edit/creation state.