Detailed Description

See also:: Class ISplineSelect, Class Animatable, Working with Shapes and Splines.

Description:: This class is available in release 3.0 and later only.

This class provides an interface to the command modes and button press operations of the Editable Spline object. To obtain a pointer to this class use the method Animatable::GetInterface() passing I_SPLINEOPS.

For example:

ISplineOps *iso = (ISplineOps*)anim->GetInterface(I_SPLINEOPS));

iso->StartCommandMode(ScmAttach);

#include <istdplug.h>

Inheritance diagram for ISplineOps:

Public Member Functions
virtual void	StartCommandMode (splineCommandMode mode)=0
virtual void	ButtonOp (splineButtonOp opcode)=0
virtual void	GetUIParam (splineUIParam uiCode, int &ret)
virtual void	SetUIParam (splineUIParam uiCode, int val)
virtual void	GetUIParam (splineUIParam uiCode, float &ret)
virtual void	SetUIParam (splineUIParam uiCode, float val)

Member Function Documentation

virtual void StartCommandMode ( splineCommandMode mode ) [pure virtual]

Parameters:: splineCommandMode mode

The mode to begin. One of the following values:

ScmCreateLine

ScmAttach

ScmInsert

ScmConnect

ScmRefine

ScmFillet

ScmChamfer

ScmBind

ScmRefineConnect

ScmOutline

ScmTrim

ScmExtend

ScmBreak

ScmUnion

ScmCrossInsert

Implemented in SplineShape.

virtual void ButtonOp ( splineButtonOp opcode ) [pure virtual]

Remarks:: Performs the same operation as a button press inside the Editable Spline UI.

Parameters:: splineButtonOp opcode

The button operation to execute. One of the following values:

SopHide

SopUnhideAll

SopDelete

SopDetach

SopDivide

SopBreak

SopCycle

SopUnbind

SopWeld

SopMakeFirst

SopAttachMultiple

SopExplode

SopReverse

SopClose

SopUnion

SopSubstract

SopIntersect

SopMirrorHoriz

SopMirrorVert

SopMirrorBoth

SopSelectByID

SopFuse

Implemented in SplineShape.

Remarks:: This method allows you to get the edit spline parameters from the command panel. Currently not in use.

Parameters:: splineUIParam uiCode

This enum is currently empty.

int &ret

The returned value.

Reimplemented in SplineShape.

{ }

Remarks:: This method allows you to set the edit spline parameters from the command panel. Currently not in use.

Parameters:: splineUIParam uiCode

This enum is currently empty.

int val

The value to set.

Reimplemented in SplineShape.

{ }

Remarks:: This method allows you to get the edit spline parameters from the command panel. Currently not in use.

Parameters:: splineUIParam uiCode

This enum is currently empty.

float &ret

The returned value.

Reimplemented in SplineShape.

{ }

Remarks:: This method allows you to set the edit spline parameters from the command panel. Currently not in use.

Parameters:: splineUIParam uiCode

This enum is currently empty.

float val

The value to set.

Reimplemented in SplineShape.

{ }