WSMObject Class Reference

This reference page is linked to from the following overview topics: World-Space Modifiers, World Space Modifier Plug-in Overview.

---

Search for all occurrences

---

Detailed Description

This class is a base class used to derived the helper object for a space warp modifier (WSM Modifier).

World Space Object plug-ins use a Super Class ID of WSM_OBJECT_CLASS_ID.

See also:

Class Object, Class SimpleWSMObject, Class ForceField, Class CollisionObject

#include <object.h>

Inheritance diagram for WSMObject:

List of all members.

Public Member Functions
SClass_ID	SuperClassID ()
	Implemented by the System.
virtual Modifier *	CreateWSMMod (INode *node)=0
	When the user binds a node to a space warp, a new modifier must be created and added to the node's WSM derived object.
virtual int	UsesWireColor ()
	This is a method of Object.
virtual BOOL	NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm)
	This is a method of Object.
virtual BOOL	SupportsDynamics ()
	Returns TRUE if spacewarp or collision object supports Dynamics; otherwise FALSE.
virtual ForceField *	GetForceField (INode *node)
	Returns a pointer to a ForceField.
virtual CollisionObject *	GetCollisionObject (INode *node)
	This method returns the collision object for the WSM.
CoreExport void *	GetInterface (ULONG id)
	Inherited from Animatable.

---

Member Function Documentation

SClass_ID SuperClassID

(

)

[inline, virtual]

Search for all occurrences

Implemented by the System.

Returns the super class ID of this plug-in type: WSM_OBJECT_CLASS_ID.

Reimplemented from ReferenceTarget.

{ return WSM_OBJECT_CLASS_ID; }                

virtual Modifier* CreateWSMMod

(

INode *

node

)

[pure virtual]

Search for all occurrences

When the user binds a node to a space warp, a new modifier must be created and added to the node's WSM derived object.

This method creates the new modifier.

Parameters:

node	The node of the WSMObject.

Returns:

A pointer to the new modifier.

Implemented in SimpleOSMToWSMObject.

virtual int UsesWireColor

(

)

[inline, virtual]

Search for all occurrences

This is a method of Object.

Below is shown the default implementation provided by this class.

Reimplemented from Object.

{ return FALSE; }   // TRUE if the object color is used for display

virtual BOOL NormalAlignVector	(	TimeValue	t,
		Point3 &	pt,
		Point3 &	norm
	)		[inline, virtual]

Search for all occurrences

This is a method of Object.

Below is shown the default implementation provided by this class.

Reimplemented from Object.

{pt=Point3(0,0,0);norm=Point3(0,0,-1);return TRUE;}

virtual BOOL SupportsDynamics

(

)

[inline, virtual]

Search for all occurrences

Returns TRUE if spacewarp or collision object supports Dynamics; otherwise FALSE.

{ return FALSE; } // TRUE if spacewarp or collision object supports Dynamics

virtual ForceField* GetForceField

(

INode *

node

)

[inline, virtual]

Search for all occurrences

Returns a pointer to a ForceField.

This pointer can be used during dynamics calculations, but should not be hung on to after that. For example, you shouldn't have the pointer long enough for it to be possible for the user to delete the space warp object. When you're done using the ForceField call its DeleteThis() method. This method may be called several times on the same space warp object with different INode* if it is instanced.

Parameters:

node	This is the space warp object's node.

{return NULL;}

virtual CollisionObject* GetCollisionObject

(

INode *

node

)

[inline, virtual]

Search for all occurrences

This method returns the collision object for the WSM.

This works just like GetForceField() documented above.

Parameters:

node	This is the space warp object's node.

{return NULL;}      

CoreExport void* GetInterface

(

ULONG

id

)

[virtual]

Search for all occurrences

Inherited from Animatable.

Returns a pointer to the interface.

Parameters:

id	- The id of the interface.

Returns:

A Pointer to the Interface

Reimplemented from Object.