HelperObject Class Reference

This reference page is linked to from the following overview topics: Object Plug-ins, Plug-in Base Classes.

---

Search for all occurrences

---

Detailed Description

This is used as a base class to create helper object plug-ins.

It simply provides implementations for a few of the methods of Animatable and Object.

See also:

Class Object, Class Animatable.

#include <object.h>

Inheritance diagram for HelperObject:

List of all members.

Public Member Functions
SClass_ID	SuperClassID ()
	Implemented by the System.
int	IsRenderable ()
	Implemented by the System.
virtual void	InitNodeName (MSTR &s)
	Implemented by the System.
virtual int	UsesWireColor ()
	Implemented by the System.
virtual BOOL	NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm)
	Objects that don't support the IntersectRay() method (such as helper objects) can implement this method to provide a default vector for use with the normal align command in 3ds Max.

---

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: HELPER_CLASS_ID

Reimplemented from ReferenceTarget.

{ return HELPER_CLASS_ID; }

int IsRenderable

(

)

[inline, virtual]

Search for all occurrences

Implemented by the System.

Returns 0 to indicate this object type may not be rendered.

Implements Object.

Reimplemented in DummyObject.

{ return(0); }

virtual void InitNodeName

(

MSTR &

s

)

[inline, virtual]

Search for all occurrences

Implemented by the System.

Sets the default node name to "Helper".

Implements Object.

Reimplemented in DummyObject, SphereGizmoObject, CylGizmoObject, BoxGizmoObject, SimpleManipulator, PFSimpleAction, MSPluginObject< HelperObject >, and MSObjectXtnd< HelperObject, MSPluginHelper >.

{ s = _M("Helper"); }

virtual int UsesWireColor

(

)

[inline, virtual]

Search for all occurrences

Implemented by the System.

Returns TRUE to indicate the object color is used for display.

Reimplemented from Object.

Reimplemented in MSPluginHelper, MSHelperXtnd, MSPluginSimpleManipulator, and MSSimpleManipulatorXtnd.

{ 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

Objects that don't support the IntersectRay() method (such as helper objects) can implement this method to provide a default vector for use with the normal align command in 3ds Max.

Parameters:

t	The time to compute the normal align vector.
pt	The point of intersection.
norm	The normal at the point of intersection.

Returns:

TRUE if this method is implemented to return the normal align vector; otherwise FALSE.

Reimplemented from Object.

Reimplemented in ConstObject, MSPluginHelper, MSHelperXtnd, MSPluginSimpleManipulator, and MSSimpleManipulatorXtnd.

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