IManipulatorMgr Class Reference

#include <manipulator.h>

Inheritance diagram for IManipulatorMgr:

Public Types
enum	ObjectManipulatorDisplayMode { kAllManipulators = 0 , kActiveManipulators = 1 , kNumObjectManipulatorDisplayModes }
enum	{   makeSphere , makeTorus , makeBox , makePlane ,   makePlaneFromPts , makePlaneFromNormal , getmsXYPlane , getmsXZPlane ,   getmsYZPlane , makeGizmoShape , makeCircle , getObjectManipDisplayMode ,   setObjectManipDisplayMode }
enum	{ objectManipMode }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
virtual Mesh *	MakeSphere (const Point3 &pos, float radius, int segments)=0
virtual Mesh *	MakeTorus (const Point3 &pos, float radius, float radius2, int segs, int sides)=0
virtual Mesh *	MakeBox (const Point3 &pos, float l, float w, float h, int lsegs, int wsegs, int hsegs)=0
virtual Plane *	MakePlane ()=0
virtual Plane *	MakePlane (const Point3 &p1, const Point3 &p2, const Point3 &p3)=0
virtual Plane *	MakePlane (const Point3 &normal, const Point3 &point)=0
virtual Plane *	GetmsXYPlane ()=0
virtual Plane *	GetmsXZPlane ()=0
virtual Plane *	GetmsYZPlane ()=0
virtual GizmoShape *	MakeGizmoShape ()=0
virtual GizmoShape *	MakeCircle (const Point3 &center, float radius, int segments)=0
virtual ObjectManipulatorDisplayMode	GetObjectManipulatorMode ()=0
virtual ObjectManipulatorDisplayMode	SetObjectManipulatorMode (ObjectManipulatorDisplayMode newMode)=0
Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()
CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
CoreExport	~FPInterfaceDesc ()
virtual void	Init ()
LifetimeType	LifetimeControl ()
virtual BaseInterface *	GetInterface (Interface_ID id)
CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor.
CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor.
CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor.
CoreExport void	SetClassDesc (ClassDesc *i_cd)
CoreExport va_list	check_fn (va_list ap, int id)
CoreExport va_list	scan_fn (va_list ap, int id, int index)
CoreExport va_list	check_prop (va_list ap, int id)
CoreExport va_list	scan_prop (va_list ap, int id, int index)
CoreExport va_list	check_enum (va_list ap, EnumID id)
CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)
FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()
CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)
ActionTable *	GetActionTable ()
CoreExport void	EnableActions (BOOL onOff)
virtual CoreExport HINSTANCE	HInstance ()
virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)
Public Member Functions inherited from FPInterface
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDesc ()=0
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID
MSTR	internal_name
StringResID	description
ClassDesc *	cd
USHORT	flags
Tab< FPFunctionDef * >	functions
Tab< FPPropDef * >	props
Tab< FPEnum * >	enumerations
MSPluginClass *	pc
Rollout *	rollout
ActionTable *	action_table
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Detailed Description

See also

Class FPStaticInterface

Description:

This is the abstract interface class for Manipulator Manager Objects

The Interface ID of this class is MANIP_MGR_INTERFACE.

Member Enumeration Documentation

ObjectManipulatorDisplayMode

enum ObjectManipulatorDisplayMode

Enumerator
kAllManipulators
kActiveManipulators
kNumObjectManipulatorDisplayModes

                                      {
        kAllManipulators = 0,
        kActiveManipulators = 1,
        // Must be last
        kNumObjectManipulatorDisplayModes
    };

anonymous enum

anonymous enum

Enumerator
makeSphere
makeTorus
makeBox
makePlane
makePlaneFromPts
makePlaneFromNormal
getmsXYPlane
getmsXZPlane
getmsYZPlane
makeGizmoShape
makeCircle
getObjectManipDisplayMode
setObjectManipDisplayMode

         { makeSphere, makeTorus, makeBox, makePlane, makePlaneFromPts,
           makePlaneFromNormal, getmsXYPlane, getmsXZPlane, getmsYZPlane,
           makeGizmoShape, makeCircle, getObjectManipDisplayMode,
           setObjectManipDisplayMode };

anonymous enum

anonymous enum

Enumerator
objectManipMode

{ objectManipMode };

Member Function Documentation

MakeSphere()

virtual Mesh * MakeSphere ( const Point3 &  pos, float  radius, int  segments  )

pure virtual

Remarks

This method allows you to create a spherical mesh gizmo.

Parameters:

Point3& pos

The position of the sphere.

float radius

The radius of the sphere

int segments

The number of segments in the sphere.

Returns

A pointer to the resulting mesh.

MakeTorus()

virtual Mesh * MakeTorus ( const Point3 &  pos, float  radius, float  radius2, int  segs, int  sides  )

pure virtual

Remarks

This method allows you to create a torus mesh gizmo.

Parameters:

Point3& pos

The position of the torus.

float radius

The radius of the torus.

float radius2

The second radius of the torus.

int segs

The number of segments in the torus.

int sides

The number of sides of the torus.

Returns

A pointer to the resulting mesh.

MakeBox()

virtual Mesh * MakeBox ( const Point3 &  pos, float  l, float  w, float  h, int  lsegs, int  wsegs, int  hsegs  )

pure virtual

Remarks

This method allows you to create a box mesh gizmo.

Parameters:

Point3& pos

The position of the box.

float l

The length of the box.

float w

The width of the box.

float h

The height of the box.

int lsegs

The length segments of the box.

int wsegs

The width segments of the box.

int hsegs

The height segments of the box.

Returns

A pointer to the resulting mesh.

MakePlane() [1/3]

virtual Plane * MakePlane ( )

pure virtual

Remarks

This method creates a default plane gizmo.

MakePlane() [2/3]

virtual Plane * MakePlane ( const Point3 &  p1, const Point3 &  p2, const Point3 &  p3  )

pure virtual

Remarks

This method creates a plane gizmo.

Parameters:

Point3& p1

The first point of the plane.

Point3& p2

The second point of the plane.

Point3& p3

The third point of the plane.

MakePlane() [3/3]

virtual Plane * MakePlane ( const Point3 &  normal, const Point3 &  point  )

pure virtual

Remarks

This method creates a plane gizmo.

Parameters:

Point3& normal

The normal of the plane

Point3& point

The center point in space of the plane.

GetmsXYPlane()

virtual Plane * GetmsXYPlane ( )

pure virtual

Remarks

This method returns the XY plane.

GetmsXZPlane()

virtual Plane * GetmsXZPlane ( )

pure virtual

Remarks

This method returns the XZ plane.

GetmsYZPlane()

virtual Plane * GetmsYZPlane ( )

pure virtual

Remarks

This method returns the YZ plane.

MakeGizmoShape()

virtual GizmoShape * MakeGizmoShape ( )

pure virtual

Remarks

This method will create a default gizmo shape.

MakeCircle()

virtual GizmoShape * MakeCircle ( const Point3 &  center, float  radius, int  segments  )

pure virtual

Remarks

This method will make a circular gizmo shape.

Parameters:

Point3& center

The center of the circle.

float radius

The radius of the circle.

int segments

The number of segments of the circle.

Returns

A pointer to the resulting gizmo shape.

GetObjectManipulatorMode()

virtual ObjectManipulatorDisplayMode GetObjectManipulatorMode ( )

pure virtual

Remarks

This method will get the current state of the Object Manipulator Mode.

Returns

The current object manipulator display mode.

See also

ObjectManipulatorDisplayMode

SetObjectManipulatorMode()

virtual ObjectManipulatorDisplayMode SetObjectManipulatorMode ( ObjectManipulatorDisplayMode  newMode )

pure virtual

Remarks

This method will set the current state of the Object Manipulator Mode.

Parameters:

int newMode

The new mode to use.

See also

ObjectManipulatorDisplayMode

Returns

The previous object manipulator display mode.

See also

ObjectManipulatorDisplayMode