InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISetPencilPrefsCmdData Class Referenceabstract

#include <ISetPencilPrefsCmdData.h>

Inheritance diagram for ISetPencilPrefsCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISETPENCILPREFSCMDDATA }
 

Public Member Functions

virtual void Set (const PMReal &fidelity, const PMReal &smoothness, const PMReal &editTolerance, const bool16 editSelected, const bool16 selected)=0
 
virtual const PMRealGetFidelity () const =0
 
virtual const PMRealGetSmoothness () const =0
 
virtual const PMRealGetEditTolerance () const =0
 
virtual const bool16 GetEditSelected () const =0
 
virtual const bool16 GetSelected () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This is a command data interface of using SetPencilPrefsCmd and SetSmoothPrefsCmd.

See Also
kSetPencilPrefsCmdBoss and kSetSmoothPrefsCmdBoss

Member Function Documentation

virtual const bool16 ISetPencilPrefsCmdData::GetEditSelected () const
pure virtual

Get the flag if we are going to edit the selected path or not.

Returns
bool16 the flag indicates we are going to edit the selected path or not.
virtual const PMReal& ISetPencilPrefsCmdData::GetEditTolerance () const
pure virtual

Get the tolerance value.

Returns
const PMReal& the tolerance value.
virtual const PMReal& ISetPencilPrefsCmdData::GetFidelity () const
pure virtual

Get the fidelity value.

Returns
const PMReal& the fidelity value.
virtual const bool16 ISetPencilPrefsCmdData::GetSelected () const
pure virtual

Get the selection status flag related to the edited path.

Returns
bool16 the selection status after we edit the path.
virtual const PMReal& ISetPencilPrefsCmdData::GetSmoothness () const
pure virtual

Get the smoothness value.

Returns
const PMReal& the smoothness value.
virtual void ISetPencilPrefsCmdData::Set (const PMRealfidelity,
const PMRealsmoothness,
const PMRealeditTolerance,
const bool16 editSelected,
const bool16 selected 
)
pure virtual

Set all those variables related to pencil preferences in the command data that will finally pass to CurveFit.

Parameters
fidelitythe value that indicates the point tolerance when fitting to curve)
smoothnessthe value indicates how smooth the curve should be
editTolerancethe value indicates how close to the curve shall we start to do edit.
editSelectedflag indicates if only edit the selected path or not.
selectedflag indicates if the newly created spline should be selected or not.