Object Class Reference

The object class is the base class for all objects. More...

#include <object.h>

Inheritance diagram for Object:

Public Member Functions
CoreExport	Object ()
CoreExport	~Object ()
virtual BOOL	CheckObjectIntegrity ()
	This method is used for debugging only.
virtual BOOL	HasUVW () override
	Call this method to find out if the object has UVW coordinates.
virtual BOOL	HasUVW (int mapChannel) override
	Call this method to find out if the object is has UVW coordinates for the specified mapping channel.
virtual Object *	FindBaseObject ()
	It is called to return a pointer to the base object (an object that is not a derived object).
virtual BOOL	IsParamSurface ()
	There are several methods used to access a parametric position on the surface of the object.
virtual int	NumSurfaces (TimeValue t)
	Returns the number of parametric surfaces within the object.
virtual Point3	GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
	This method needs to be implemented if Object::IsParamSurface() returns TRUE.
virtual Point3	GetSurfacePoint (TimeValue t, int surface, float u, float v, Interval &iv)
	This method is used to retrieve a point on the specified surface of the object based on two parameters of the surface, u and v.
virtual void	SurfaceClosed (TimeValue t, int surface, BOOL &uClosed, BOOL &vClosed)
	This method allows the object to return flags that indicate whether the parametric surface is closed in the U and V dimensions.
virtual BOOL	GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
	This method allows an object to return extended Properties fields.
CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
CoreExport bool	SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport MSTR	SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
CoreExport COLORREF	SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport bool	SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
	Returns true if the object is selected in its schematic view.
CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport bool	SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport void	AddXTCObject (XTCObject *pObj, int priority=0, int branchID=-1)
	This method adds an extension object into the pipeline.
CoreExport int	NumXTCObjects ()
	Returns the number of extension objects maintained by this Object.
CoreExport XTCObject *	GetXTCObject (int index)
	Returns a pointer to the specified extension object.
CoreExport void	RemoveXTCObject (int index)
	Removes the extension object as indicated by the index.
CoreExport void	SetXTCObjectPriority (int index, int priority)
	Sets the priority for the extension object whose index is passed.
CoreExport int	GetXTCObjectPriority (int index)
	Returns the integer priority number of the extension object whose index is passed.
CoreExport void	SetXTCObjectBranchID (int index, int branchID)
	Sets the branch ID of the extension object whose index is passed.
CoreExport int	GetXTCObjectBranchID (int index)
	Returns the integer branch ID of the extension object whose index is passed.
CoreExport void	MergeAdditionalChannels (Object *from, int branchID)
	This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it).
CoreExport void	BranchDeleted (int branchID, bool reorderChannels)
	This method has to be called on the CompoundObject so it can delete the XTCObjects for the specified branch.
CoreExport void	CopyAdditionalChannels (Object *from, bool deleteOld=true, bool bShallowCopy=false)
	This method copies all extension objects from the "from" object into the current object.
CoreExport void	DeleteAllAdditionalChannels ()
	Implemented by the System.
virtual BOOL	UseSelectionBrackets ()
	This method allows an object to choose whether or not it will display selection brackets in shaded viewports.
virtual BOOL	IsManipulator ()
CoreExport void *	GetInterface (ULONG id) override
CoreExport BaseInterface *	GetInterface (Interface_ID id) override
virtual void	ReduceDisplayCaches ()
	Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it.
virtual bool	NeedGWCacheRebuilt (GraphicsWindow *gw, Material *ma, int numMat)
	This returns whether the Graphics Cache for this object needs to be rebuilt.
virtual void	BuildGWCache (GraphicsWindow *gw, Material *ma, int numMat, BOOL threaded)
	This builds the graphics window cached mesh.
virtual void	StartStackEval ()
	This are called right before and after a modifier is applied to an object.
virtual void	EndStackEval ()
Object Name, Properties, Display, and IntersectRay Methods
virtual int	IsRenderable ()=0
	Indicates whether the object may be rendered.
virtual void	InitNodeName (MSTR &s)=0
	This is the default name of the node when it is created.
virtual int	UsesWireColor ()
	This method determines if the object color is used for display.
virtual int	DoOwnSelectHilite ()
	If an object wants to draw itself in the 3D viewports in its selected state in some custom manner this method should return nonzero.
virtual int	IntersectRay (TimeValue t, Ray &r, float &at, Point3 &norm)
	This method is called to compute the intersection point and surface normal at this intersection point of the ray passed and the object.
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.
Data Flow Evaluation Methods
Most plug-in procedural objects do not need to be concerned with the following methods associated with locks, channels and shallow copies. The only type of plug-ins that needs to be concerned with these methods are objects that actually flow down the pipeline. Most procedural plug-ins don't go down the pipeline, instead they convert themselves to a TriObject or PatchObject, and these goes down the pipeline. It is these TriObjects or PatchObject that deal with these methods. However plug-in objects that actually flow down the pipeline will use these methods. For more information see the Advanced Topics section on the Geometry Pipeline System.
void	LockObject ()
	Implemented by the System.
void	UnlockObject ()
	Implemented by the System.
int	IsObjectLocked ()
	Implemented by the System.
virtual ObjectState	Eval (TimeValue t)=0
	This method is called to evaluate the object and return the result as an ObjectState.
void	LockChannels (ChannelMask channels)
	Implemented by the System.
void	UnlockChannels (ChannelMask channels)
	Implemented by the System.
ChannelMask	GetChannelLocks ()
	Implemented by the System.
void	SetChannelLocks (ChannelMask channels)
	Implemented by the System.
ChannelMask	GetChannelLocks (ChannelMask m)
	Implemented by the System.
virtual BOOL	CanCacheObject ()
	This method determines if this object can have channels cached.
virtual void	WSStateInvalidate ()
	This is called by a node when the node's world space state has become invalid.
virtual BOOL	IsWorldSpaceObject ()
	Returns TRUE if the object as a world space object; otherwise FALSE.
CoreExport INode *	GetWorldSpaceObjectNode ()
	Implemented by the System.
virtual BOOL	IsParticleSystem ()
	Implemented by the System.
CoreExport void	CopyChannelLocks (Object *obj, ChannelMask needChannels)
	Implemented by the System.
virtual void	TopologyChanged ()
	Implemented by the System.
virtual int	IsDeformable ()
	Indicates whether this object is deformable.
virtual int	NumPoints ()
	The points of a deformable object are accessed through a virtual array interface.
virtual Point3	GetPoint (int i)
	The points of a deformable object are accessed through a virtual array interface.
virtual void	SetPoint (int i, const Point3 &p)
	The points of a deformable object are accessed through a virtual array interface.
virtual BOOL	IsPointSelected (int i)
	Returns TRUE if the 'i-th' point is selected; otherwise FALSE.
virtual float	PointSelection (int i)
	Returns a floating point weighted point selection if the object supports it.
virtual BOOL	HasWeights ()
	Returns TRUE if the object has weights for its points that can be set; otherwise FALSE.
virtual double	GetWeight (int i)
	Returns the weight of the specified point of the object.
virtual void	SetWeight (int i, const double w)
	Sets the weight of the specified point.
virtual BOOL	PolygonCount (TimeValue t, int &numFaces, int &numVerts)
	Retreives the number of faces and vertices of the polyginal mesh representation of this object.
virtual void	PointsWereChanged ()
	Informs the object that its points have been deformed, so it can invalidate its cache.
virtual CoreExport void	Deform (Deformer *defProc, int useSel=0)
	This is the method used to deform the object with a deformer.
virtual CoreExport void	GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm=NULL, BOOL useSel=FALSE)
	This method computes the bounding box in the objects local coordinates or the optional space defined by tm.
virtual int	IsMappable ()
	This method lets you know if the ApplyUVWMap() method is available for this object.
virtual int	NumMapChannels ()
	Returns the maximum number of channels supported by this type of object.
virtual int	NumMapsUsed ()
	Returns the number of maps currently used by this object.
virtual void	ApplyUVWMap (int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, int cap, const Matrix3 &tm, int channel=1)
	This method may be called to map the object with UVW mapping coordinates.
virtual CoreExport int	CanConvertToType (Class_ID obtype)
	Indicates whether the object can be converted to the specified type.
virtual CoreExport Object *	ConvertToType (TimeValue t, Class_ID obtype)
	This method converts this object to the type specified and returns a pointer it.
virtual Class_ID	PreferredCollapseType ()
	This method allows objects to specify the class that is the best class to convert to when the user collapses the stack.
virtual CoreExport void	GetCollapseTypes (Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
	When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented.
virtual Object *	CollapseObject ()
	This method is called on the world space cache object when the stack gets collapsed, that lets the pipeline object decide, if it wants to return a different object than itself.
virtual DWORD	GetSubselState ()
	For objects that have sub selection levels, this method returns the current selection level of the object.
virtual void	SetSubSelState (DWORD s)
	Implemented by the System.
CoreExport void	ReadyChannelsForMod (ChannelMask channels)
	Implemented by the System.
virtual CoreExport Interval	ChannelValidity (TimeValue t, int nchan)
	Retrieve the current validity interval for the nchan channel of the object.
virtual CoreExport void	SetChannelValidity (int nchan, Interval v)
	Sets the validity interval of the specified channel.
virtual CoreExport void	InvalidateChannels (ChannelMask channels)
	This method invalidates the intervals for the given channel mask.
virtual CoreExport Interval	ObjectValidity (TimeValue t)
	This method returns the validity interval of the object as a whole at the specified time.
virtual Object *	MakeShallowCopy (ChannelMask channels)
	This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels.
virtual CoreExport void	ShallowCopy (Object *fromOb, ChannelMask channels)
	This method copies the specified channels from the fromOb to this and copies the validity intervals.
virtual CoreExport void	FreeChannels (ChannelMask channels)
	This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty).
virtual CoreExport void	NewAndCopyChannels (ChannelMask channels)
	This method replaces the locked channels with newly allocated copies.
virtual CoreExport void	MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
	This method allows the object to enlarge its viewport rectangle, if it wants to.
CoreExport bool	IsBaseClassOwnedChannel (int nchan)
	Implemented by the System.
CoreExport void	UpdateValidity (int nchan, Interval v)
	When a modifier is applied to an object, it needs to include its own validity interval in the interval of the object.
Interval	GetNoEvalInterval ()
void	SetNoEvalInterval (Interval iv)
virtual CoreExport void	ReduceCaches (TimeValue t)
	This method give the object the chance to reduce its caches.
virtual int	IsConstObject ()
	This is called to determine if this is a construction object or not.
virtual int	NumPipeBranches (bool selected=true)
	This method returns the number of pipeline branches combined by the object.
virtual Object *	GetPipeBranch (int i, bool selected=true)
	Retrieves sub-object branches from an object that supports branching.
virtual INode *	GetBranchINode (TimeValue t, INode *node, int i, bool selected=true)
	When an object has sub-object branches, it is likely that the sub-objects are transformed relative to the object.
Shapes Within Objects
Shape viewports can reference shapes contained within objects, so the system needs to be able to access the shapes within an object. The following four methods provide this access. These methods are used by the loft object. Since loft objects are made up of shapes, this gives the system the ability to query the object to find out if it is a shape container. Most objects don't contain shapes so they can just use the default implementations.
virtual int	NumberOfContainedShapes ()
	Returns the number of shapes contained inside this object.
virtual ShapeObject *	GetContainedShape (TimeValue t, int index)
	This method returns the ShapeObject specified by the index passed at the time specified.
virtual void	GetContainedShapeMatrix (TimeValue t, int index, Matrix3 &mat)
	Returns the matrix associated with the shape whose index is passed.
virtual BitArray	ContainedShapeSelectionArray ()
	This is used by the lofter.
virtual BOOL	IsShapeObject ()
	Returns the number of shapes contained inside this object.
Public Member Functions inherited from BaseObject
virtual CoreExport unsigned long	GetObjectDisplayRequirement () const
virtual CoreExport bool	PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
virtual CoreExport bool	UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual CoreExport bool	UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArray &	GetRenderItems () const
virtual CoreExport void *	GetInterface (ULONG id) override
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id) override
CoreExport	BaseObject ()
virtual CoreExport	~BaseObject ()
virtual BOOL	HasViewDependentBoundingBox ()
	This method return true if GetWorldBoundBox returns different boxes for different viewports.
virtual int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt)
	This method is called to determine if the specified screen point intersects the item.
virtual void	SetExtendedDisplay (int flags)
	This method is used for storing mode-dependent display attributes.
virtual int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
	This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).
virtual void	Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt)
	Checks the point passed for a snap and updates the SnapInfo structure.
virtual void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
	This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).
virtual void	GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
	This is the object space bounding box, the box in the object's local coordinates.
virtual CreateMouseCallBack *	GetCreateMouseCallBack ()=0
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
	__declspec (deprecated) virtual const MCHAR *GetObjectName() MAX_SEALED
virtual const MCHAR *	GetObjectName (bool localized) const
virtual CoreExport BOOL	OKToChangeTopology (MSTR &modName)
	Implemented by the System.
virtual BOOL	ChangeTopology ()
	This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE.
virtual void	ForceNotify (Interval &i)
	Notifies dependents of a change.
virtual IParamArray *	GetParamBlock ()
	An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
virtual IParamBlock2 *	GetParamBlock (int i) override
	An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
virtual int	GetParamBlockIndex (int id)
	If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block.
virtual void	Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by moving its selected sub-object components.
virtual void	Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by rotating its selected sub-object components.
virtual void	Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by scaling its selected sub-object components.
virtual void	TransformStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect.
virtual void	TransformHoldingStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect.
virtual void	TransformHoldingFinish (TimeValue t)
	This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted.
virtual void	TransformFinish (TimeValue t)
	This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted.
virtual void	TransformCancel (TimeValue t)
	This method is called when the transform operation is canceled by a right-click and the undo has been canceled.
virtual int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc)
	This method is used in modifier gizmo hit testing.
virtual int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flags, ModContext *mc)
	When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM.
virtual void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc)
	This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo).
virtual void	CloneSelSubComponents (TimeValue t)
	This method is called to make a copy of the selected sub-object components of the item.
virtual void	AcceptCloneSelSubComponents (TimeValue t)
	This method is called when the user mouses up after shift-cloning a sub-object selection.
virtual void	SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
	This method is called to change the selection state of the component identified by hitRec.
virtual void	ClearSelection (int selLevel)
	This method is called to clear the selection for the given sub-object level.
virtual void	SelectAll (int selLevel)
	This method is called to select every element of the given sub-object level.
virtual void	InvertSelection (int selLevel)
	This method is called to invert the specified sub-object level.
virtual int	SubObjectIndex (HitRecord *hitRec)
	Returns the index of the sub-object element identified by the HitRecord hitRec.
virtual void	ActivateSubobjSel (int level, XFormModes &modes)
	When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in.
virtual BOOL	SupportsNamedSubSels ()
	An object that supports sub-object selection can choose to support named sub object selection sets.
virtual void	ActivateSubSelSet (MSTR &setName)
	When the user chooses a name from the drop down list this method is called.
virtual void	NewSetFromCurSel (MSTR &setName)
	If the user types a new name into the named selection set drop down then this method is called.
virtual void	RemoveSubSelSet (MSTR &setName)
	If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called.
virtual void	SetupNamedSelDropDown ()
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual int	NumNamedSelSets ()
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual MSTR	GetNamedSelSetName (int i)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual void	SetNamedSelSetName (int i, MSTR &newName)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual void	NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual void	GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
virtual void	GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
virtual void	NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
	This method is called before a modifier or object is collapsed.
virtual void	NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
	This method is called after a modifier or object is collapsed.
virtual int	NumSubObjTypes ()
	Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType().
virtual ISubObjType *	GetSubObjType (int i)
	Returns a pointer to the sub-object type for the sub-object whose index is passed.
virtual CoreExport int	GetSubObjectLevel ()
	This method returns an integer which indicates the current sub-object level of the modifier or base object.
virtual void	SetGenUVW (BOOL sw)
	This method is called to change the state of its Generate UVW boolean.
virtual void	SetGenUVW (int mapChannel, BOOL sw)
	This method is called to change the state of its Generate UVW boolean for the specified mapping channel.
virtual void	ShowEndResultChanged (BOOL showEndResult)
	This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled).
Public Member Functions inherited from ReferenceTarget
CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
BOOL	IsRefTarget () override
	Checks if this is a ReferenceTarget.
CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference.
CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references.
CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents.
void	BeginDependencyTest ()
	Starts Dependency Test.
BOOL	EndDependencyTest ()
	Ends Dependency Test.
virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target.
virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo.
	__declspec (deprecated) virtual void RefDeleted() final
virtual void	RefDeleted (ReferenceMaker *oldOwner)
	Called after a reference to this is deleted.
	__declspec (deprecated) virtual void RefDeletedUndoRedo() final
virtual void	RefDeletedUndoRedo (RefMakerHandle oldOwner)
	Called after a reference to this is deleted because of undo or redo.
CoreExport RefResult	DeleteAllRefsToMe () override
	Deletes all references to this ReferenceTarget.
CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this.
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.
virtual CoreExport RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object.
virtual CoreExport void	BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
	This method copies base class data from an object to its clone.
CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=nullptr, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS) override
	Notify all dependent RefMakers concerned with the message.
void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline.
virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG.
virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets.
CoreExport void *	GetInterface (ULONG id) override
	Inherited from Animatable.
CoreExport BaseInterface *	GetInterface (Interface_ID id) override
	Inherited from Animatable.
CoreExport	ReferenceTarget ()
	Constructor.
virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents.
CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents.
Public Member Functions inherited from ReferenceMaker
void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers.
CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker.
CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item.
CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference.
virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered.
CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual CoreExport IOResult	Save (ISave *isave)
	Called for saving data.
virtual CoreExport IOResult	Save (ISave *isave, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual CoreExport IOResult	Load (ILoad *iload)
	Called for loading data.
virtual CoreExport IOResult	Load (ILoad *iload, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references.
virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy.
CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags) override
	Enumerate auxiliary files (e.g. bitmaps)
virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration.
virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save.
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.
CoreExport bool	EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
	This method provides a general purpose reference enumerator.
CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget.
BOOL	IsRefMaker () override
	Tells whether it is a ReferenceMaker.
virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not.
virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save.
CoreExport	ReferenceMaker ()
	Constructor.
CoreExport void	DeleteMe ()
	Deletes an instance of this class.
virtual CoreExport int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold.
virtual CoreExport RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference.
Public Member Functions inherited from Animatable
virtual void	FreeCaches ()
virtual int	NumChildren ()
virtual Animatable *	ChildAnim (int i)
virtual CoreExport MSTR	NodeName ()
virtual void	EditTrack ()
virtual CoreExport BOOL	SubAnimSetKeyBufferPresent (int subNum)
	returns true if the sub-anim has a "Set Key" buffer present
virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present
virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim.
virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers.
virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim.
virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers.
virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete.
virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker.
virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used.
virtual bool	GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
	This method is called to access the object specified name to use for the Maxscript macrorecorder.
CoreExport	Animatable ()
	Constructor.
virtual CoreExport void	DeleteThis ()
	Deletes an instance of this class.
MSTR	ClassName (bool localized=true) const
	Returns the name of the plugin class.
virtual CoreExport Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class.
virtual void	BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev=NULL)
virtual void	EndEditParams (IObjParam *ip, ULONG flags, Animatable *next=NULL)
virtual CoreExport void	ReleaseInterface (ULONG id, void *i)
virtual CoreExport int	SetProperty (ULONG id, void *data)
virtual CoreExport void *	GetProperty (ULONG id)
CoreExport void	AppendProperty (AnimProperty *prop)
	A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs.
CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property.
CoreExport void	AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
	Adds application/plugin specific (custom) data to an Animatable.
CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable.
CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable.
CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable.
virtual int	NumSubs ()
virtual Animatable *	SubAnim (int i)
	__declspec (deprecated) virtual MSTR SubAnimName(int i) MAX_SEALED
virtual CoreExport MSTR	SubAnimName (int i, bool localized)
virtual BOOL	CanDeleteSubAnim (int i)
virtual void	DeleteSubAnim (int i)
virtual DWORD	GetSubAnimCurveColor (int subNum)
virtual int	SubNumToRefNum (int subNum)
virtual BOOL	CanCopyAnim ()
CoreExport int	HasSubElements (int type=0)
virtual int	GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	The values max and min should be initialized before calling this function.
virtual ParamDimension *	GetParamDimension (int i)
virtual BOOL	SelectSubAnim (int subNum)
virtual BOOL	BypassTreeView ()
virtual BOOL	BypassTrackBar ()
virtual BOOL	BypassPropertyLevel ()
virtual BOOL	InvisibleProperty ()
virtual int	NumKeys ()
virtual TimeValue	GetKeyTime (int index)
virtual int	GetKeyIndex (TimeValue t)
virtual BOOL	GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
virtual void	CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
virtual void	DeleteKeyAtTime (TimeValue t)
virtual BOOL	IsKeyAtTime (TimeValue t, DWORD flags)
virtual int	GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
virtual int	GetKeySelState (BitArray &sel, Interval range, DWORD flags)
CoreExport void	OpenTreeEntry (int type, DWORD tv)
CoreExport void	CloseTreeEntry (int type, DWORD tv)
CoreExport int	IsTreeEntryOpen (int type, DWORD tv)
CoreExport BOOL	GetSelInTrackView (DWORD tv)
CoreExport void	SetSelInTrackView (DWORD tv, BOOL sel)
CoreExport BOOL	InTrackViewSelSet (int which)
CoreExport void	SetTrackViewSelSet (int which, BOOL inOut)
virtual BOOL	AssignController (Animatable *control, int subAnim)
virtual BOOL	CanAssignController (int subAnim)
	Return true if we can reassign the subanim specified.
virtual BOOL	CanMakeUnique ()
CoreExport int	EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
virtual int	RenderBegin (TimeValue t, ULONG flags=0)
virtual int	RenderEnd (TimeValue t)
virtual CoreExport Interval	GetTimeRange (DWORD flags)
virtual void	EditTimeRange (Interval range, DWORD flags)
virtual void	DeleteTime (Interval iv, DWORD flags)
virtual void	ReverseTime (Interval iv, DWORD flags)
virtual void	ScaleTime (Interval iv, float s)
virtual void	InsertTime (TimeValue ins, TimeValue amount)
virtual BOOL	SupportTimeOperations ()
virtual CoreExport void	MapKeys (TimeMap *map, DWORD flags)
virtual void	DeleteKeys (DWORD flags)
virtual void	DeleteKeyByIndex (int index)
virtual void	SelectKeys (TrackHitTab &sel, DWORD flags)
virtual void	SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
virtual void	SelectSubCurve (int subNum, BOOL sel)
virtual void	SelectKeyByIndex (int i, BOOL sel)
virtual BOOL	IsKeySelected (int i)
virtual void	FlagKey (TrackHitRecord hit)
virtual int	GetFlagKeyIndex ()
virtual int	NumSelKeys ()
virtual void	CloneSelectedKeys (BOOL offset=FALSE)
virtual void	AddNewKey (TimeValue t, DWORD flags)
virtual void	MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
virtual void	ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
virtual void	SelectCurve (BOOL sel)
virtual BOOL	IsCurveSelected ()
	Returns TRUE if the function curve is selected; otherwise returns FALSE.
virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed.
virtual int	GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
virtual void	SetSelKeyCoords (TimeValue t, float val, DWORD flags)
virtual int	SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
virtual CoreExport BOOL	IsAnimated ()
virtual BOOL	CanCopyTrack (Interval iv, DWORD flags)
virtual BOOL	CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
virtual TrackClipObject *	CopyTrack (Interval iv, DWORD flags)
virtual void	PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
virtual BOOL	CanCopySubTrack (int subNum, Interval iv, DWORD flags)
virtual BOOL	CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
virtual TrackClipObject *	CopySubTrack (int subNum, Interval iv, DWORD flags)
virtual void	PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
virtual int	GetTrackVSpace (int lineHeight)
virtual int	HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)
virtual int	PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
virtual int	PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
virtual int	PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual void	EditTrackParams (TimeValue t, ParamDimensionBase *dim, const MCHAR *pname, HWND hParent, IObjParam *ip, DWORD flags)
virtual int	TrackParamsType ()
virtual int	GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	This method is called to calculate the largest and smallest values of the anim.
CoreExport void	AddNoteTrack (NoteTrack *note)
CoreExport void	DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)
CoreExport BOOL	HasNoteTracks ()
CoreExport int	NumNoteTracks ()
CoreExport NoteTrack *	GetNoteTrack (int i)
virtual void	FreeAllBitmaps ()
virtual void	GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
virtual BOOL	IsSubClassOf (Class_ID classID)
	returns true if the animatable has sub-classed off the given class
virtual CoreExport void	MouseCycleCompleted (TimeValue t)
virtual CoreExport void	MouseCycleStarted (TimeValue t)
virtual int	NumParamBlocks ()
virtual IParamBlock2 *	GetParamBlockByID (short id)
CoreExport bool	SvSaveData (ISave *isave, USHORT id)
CoreExport bool	SvLoadData (ILoad *iLoad)
CoreExport DWORD	SvGetRefIndex ()
CoreExport void	SvSetRefIndex (DWORD i)
CoreExport bool	SvDeleteRefIndex ()
CoreExport SvGraphNodeReference	SvStdTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
virtual CoreExport bool	SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
virtual CoreExport bool	SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
virtual CoreExport bool	SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
	Called when the user deletes this object in the schematic view...
virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
virtual CoreExport bool	SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
virtual CoreExport bool	SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"...
virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method...
virtual CoreExport bool	SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship.
virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view...
CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class.
CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container.
CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container.
void	SetAFlag (DWORD mask)
void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags.
bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags.
void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags.
void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags.
bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags.
CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit.
CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit.
CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit.
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 Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted.
static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object.
static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle.
static CoreExport AnimHandle	GetNextHandle ()
	Get the unique handle for the next Animatable object to be created.
static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables.
static CoreExport bool	RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport void	ClearAFlagInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable flags in all Animatables.
static CoreExport void	ClearAFlagExInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable extended flags in all Animatables.
static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index.
static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index.
static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables.
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.
Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0
Protected Member Functions inherited from ReferenceTarget
CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep) override
	Method to perform an enumeration on a ReferenceTarget.
virtual CoreExport	~ReferenceTarget ()=0
	Destructor.
Protected Member Functions inherited from ReferenceMaker
virtual CoreExport	~ReferenceMaker ()=0
	Destructor.
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`.
void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target.
void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target.
int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target.
CoreExport RefResult	StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
	Validates a given reference link between this reference maker and its reference target.
Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor.
Protected Member Functions inherited from Noncopyable
	Noncopyable ()
	~Noncopyable ()
Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray	mRenderItemHandles
Protected Attributes inherited from Animatable
DWORD	aflag
AnimPropertyList	aprops

Detailed Description

The object class is the base class for all objects.

An object is one of two things: A procedural object or a derived object. Derived objects are part of the system and may not be created by plug-ins. They are containers for modifiers. Procedural objects can be many different things such as cameras, lights, helper objects, geometric objects, etc. Methods of this class are responsible for things such as allowing the object to be deformed (changing its points), retrieving a deformed bounding box, converting the object between different types (to a mesh or patch for example), texture mapping the object (if appropriate) and interacting with the system regarding mapping. There are other methods involved in validity intervals for the object and its channels, and a method used to return the sub-object selection state of the object.

Method Groups:

See Method Groups for Class Object.

See also

Class BaseObject, Class Deformer, Class Interval, Class GraphicsWindow,

Template Class Tab, Geometry Pipeline System

Constructor & Destructor Documentation

Object()

CoreExport Object

(

)

~Object()

CoreExport ~Object

(

)

Member Function Documentation

IsRenderable()

virtual int IsRenderable ( )

pure virtual

Indicates whether the object may be rendered.

Some objects such as construction grids and helpers should not be rendered and can return zero.

Returns

Nonzero if the object may be rendered; otherwise 0.

Implemented in DummyObject, CameraObject, LightObject, SimpleWSMObject, MSPluginGeomObject, MSGeomObjectXtnd, MSPluginShape, MSShapeXtnd, HelperObject, GeomObject, and ShapeObject.

InitNodeName()

virtual void InitNodeName ( MSTR &  s )

pure virtual

This is the default name of the node when it is created.

Parameters

s	The default name of the node is stored here.

Implemented in DummyObject, GizmoObject, SphereGizmoObject, CylGizmoObject, BoxGizmoObject, SimpleManipulator, PFSimpleAction, SimpleObjectBase, SimpleWSMObject, SimpleParticle, SimpleShape, SimpleSpline, SplineShape, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSPluginShape, MSShapeXtnd, MSSimpleObjectXtnd, CameraObject, LightObject, HelperObject, GeomObject, ShapeObject, and SimplePolyObject.

UsesWireColor()

virtual int UsesWireColor ( )

inlinevirtual

This method determines if the object color is used for display.

Returns

TRUE if the object color is used for display; otherwise FALSE.

Reimplemented in MSPluginHelper, MSHelperXtnd, MSPluginLight, MSLightXtnd, MSPluginCamera, MSCameraXtnd, MSPluginSimpleManipulator, MSSimpleManipulatorXtnd, CameraObject, HelperObject, and WSMObject.

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

DoOwnSelectHilite()

virtual int DoOwnSelectHilite ( )

inlinevirtual

If an object wants to draw itself in the 3D viewports in its selected state in some custom manner this method should return nonzero.

If this item returns nonzero, the BaseObject::Display() method should respect the selected state of the object when it draws itself. If this method returns zero the system will use its standard method of showing the object as selected.

Returns

Nonzero if the object will draw itself in the selected state; otherwise 0. If nonzero, the plug-in developer is responsible for displaying the object in the selected state as part of its Display() method.

Reimplemented in DummyObject, SimpleWSMObject, and SimpleParticle.

{ return 0; }

IntersectRay()

virtual int IntersectRay ( TimeValue  t, Ray &  r, float &  at, Point3 &  norm  )

inlinevirtual

This method is called to compute the intersection point and surface normal at this intersection point of the ray passed and the object.

Parameters

t	The time to compute the intersection.
r	Ray to intersect. See Class Ray.
at	The point of intersection.
norm	Surface normal at the point of intersection.

Returns

Nonzero if a point of intersection was found; otherwise 0.

See also

The Mesh class implementation of this method.

Reimplemented in MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSSimpleObjectXtnd, PatchObject, PolyObject, SimpleObjectBase, TriObject, MSPluginShape, MSShapeXtnd, ShapeObject, and SimplePolyObject.

{return FALSE;}

NormalAlignVector()

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

inlinevirtual

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 in MSPluginHelper, MSHelperXtnd, MSPluginSimpleManipulator, MSSimpleManipulatorXtnd, HelperObject, ConstObject, ParticleObject, and WSMObject.

{return FALSE;}

LockObject()

void LockObject ( )

inline

Implemented by the System.

This method locks the object as a whole. The object defaults to not modifiable.

{ locked |= OBJECT_LOCKED; }

UnlockObject()

void UnlockObject ( )

inline

Implemented by the System.

This method unlocks the object as a whole.

{ locked &= ~OBJECT_LOCKED; }

IsObjectLocked()

int IsObjectLocked ( )

inline

Implemented by the System.

Returns nonzero if the object is locked; otherwise 0.

{ return (locked&OBJECT_LOCKED ? 1 : 0); }

Eval()

virtual ObjectState Eval ( TimeValue  t )

pure virtual

This method is called to evaluate the object and return the result as an ObjectState.

When the system has a pointer to an object it doesn't know if it's a procedural object or a derived object. So it calls Eval() on it and gets back an ObjectState. A derived object managed by the system may have to call Eval() on its input for example. A plug-in (like a procedural object) typically just returns itself. A plug-in that does not just return itself is the Morph Object (/MAXSDK/SAMPLES/OBJECTS/MORPHOBJ.CPP). This object uses a morph controller to compute a new object and fill in an ObjectState which it returns.

Parameters

t	Specifies the time to evaluate the object.

Returns

The result of evaluating the object as an ObjectState.

Sample Code:

Typically this method is implemented as follows:

{ return ObjectState(this); }

Implemented in PFSimpleAction, PatchObject, DummyObject, GizmoObject, LinearShape, SimpleManipulator, PolyObject, SimpleObjectBase, SimpleWSMObject, SimpleParticle, SimpleShape, SimpleSpline, SplineShape, TriObject, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSHelperXtnd, MSShapeXtnd, MSSimpleObjectXtnd, and SimplePolyObject.

LockChannels()

void LockChannels ( ChannelMask  channels )

inline

Implemented by the System.

Locks the specified channels of the object.

Parameters

channels

The channels to lock.

{ locked |= channels; } 

UnlockChannels()

void UnlockChannels ( ChannelMask  channels )

inline

Implemented by the System.

Unlocks the specified channel(s) of the object.

Parameters

channels

Specifies the channels to unlock.

{ locked &= ~channels; }

GetChannelLocks() [1/2]

ChannelMask GetChannelLocks ( )

inline

Implemented by the System.

Returns the locked status of the channels.

Returns

The channels of the object that are locked.

{ return locked; }    

SetChannelLocks()

void SetChannelLocks ( ChannelMask  channels )

inline

Implemented by the System.

Sets the locked status of the object's channels.

Parameters

channels

The channel to set to locked.

{ locked = channels; }    

GetChannelLocks() [2/2]

ChannelMask GetChannelLocks ( ChannelMask  m )

inline

Implemented by the System.

Returns the locked status of the channels.

Parameters

m

Not used.

Returns

The channels of the object that are locked.

{ return locked; }

CanCacheObject()

virtual BOOL CanCacheObject ( )

inlinevirtual

This method determines if this object can have channels cached.

Particle objects flow up the pipeline without making shallow copies of themselves and therefore cannot be cached. Objects other than particle system can just use the default implementation.

Returns

TRUE if the object can be cached; otherwise FALSE.

Reimplemented in ParticleObject.

{return TRUE;}

WSStateInvalidate()

virtual void WSStateInvalidate ( )

inlinevirtual

This is called by a node when the node's world space state has become invalid.

Normally an object does not (and should not) be concerned with this, but in certain cases like particle systems an object is effectively a world space object an needs to be notified.

Reimplemented in SimpleParticle.

{}

IsWorldSpaceObject()

virtual BOOL IsWorldSpaceObject ( )

inlinevirtual

Returns TRUE if the object as a world space object; otherwise FALSE.

World space objects (particles for example) can not be instanced because they exist in world space not object space. Objects other than particle system can just use the default implementation.

Reimplemented in SimpleParticle.

{return FALSE;}

GetWorldSpaceObjectNode()

CoreExport INode * GetWorldSpaceObjectNode

(

)

Implemented by the System.

This method locks the object as a whole. The object defaults to not modifiable.

IsParticleSystem()

virtual BOOL IsParticleSystem ( )

inlinevirtual

Implemented by the System.

This method locks the object as a whole. The object defaults to not modifiable.

Reimplemented in ParticleObject.

{return FALSE;}

CopyChannelLocks()

CoreExport void CopyChannelLocks	(	Object *	obj,
		ChannelMask	needChannels
	)

Implemented by the System.

Copies the specified channels from the object passed.

Parameters

obj	The source object.
needChannels	Indicates the channels to copy.

TopologyChanged()

virtual void TopologyChanged ( )

inlinevirtual

Implemented by the System.

This method locks the object as a whole. The object defaults to not modifiable.

Reimplemented in PatchObject, PolyObject, and TriObject.

{ }

IsDeformable()

virtual int IsDeformable ( )

inlinevirtual

Indicates whether this object is deformable.

A deformable object is simply an object with points that can be modified. Deformable objects must implement the generic deformable object methods (NumPoints(), GetPoint(i), SetPoint(i), Deform()). A deformable object is simply an object with points that can be modified. These points can be stored in any form the object wants. They are accessed through a virtual array interface with methods to get and set the 'i-th' point. If an object has tangents for instance, it would convert them to and from points as necessary. For example, a simple Bezier spline object that stored its control handles relative to the knot would convert them to be absolute when GetPoint() was called with 'i' specifying one of the control points. When the control point is later set, the object can convert it back to be relative to its knot. At this point it could also apply any constraints that it may have, such as maintaining a degree of continuity. The idea is that the entity calling GetPoint(i) and SetPoint(i) doesn't care what the point represents. It will simply apply some function to the point.

Note

The Deformable object methods only need to be implemented if the object returns TRUE from this method.

Returns

Return nonzero if the object is deformable and implements the generic deformable object methods; otherwise 0.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, TriObject, and ParticleObject.

{ return 0; } 

NumPoints()

virtual int NumPoints ( )

inlinevirtual

The points of a deformable object are accessed through a virtual array interface.

This method specifies the number of points in the object. The meaning of 'points' is defined by the object. A TriObject uses the vertices as the points for example. b>

Returns

The number of points in the object.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

{ return 0;}

GetPoint()

virtual Point3 GetPoint ( int  i )

inlinevirtual

The points of a deformable object are accessed through a virtual array interface.

This method returns the 'i-th' point of the object.

Note

If your plug-in is a modifier and you want to operate on the selected points of the object you are modifying, you can't tell which points are selected unless you know the type of object. If it is a generic deformable object there is no way of knowing since the way the object handles selection is up to it. Therefore, if you want to operate on selected points of a generic deformable object, use a Deformer.

Parameters

i	Specifies which point should be returned.

Returns

The 'i-th' point of the object.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

{ return Point3(0,0,0); }

SetPoint()

virtual void SetPoint ( int  i, const Point3 &  p  )

inlinevirtual

The points of a deformable object are accessed through a virtual array interface.

This method stores the 'i-th' point of the object.

Parameters

i	The index of the point to store.
p	The point to store.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

{}             

IsPointSelected()

virtual BOOL IsPointSelected ( int  i )

inlinevirtual

Returns TRUE if the 'i-th' point is selected; otherwise FALSE.

Parameters

i	The zero based index of the point to check.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

{ return FALSE; }

PointSelection()

virtual float PointSelection ( int  i )

inlinevirtual

Returns a floating point weighted point selection if the object supports it.

The default implementation just returns 1.0f if selected and 0.0f if not.

Parameters

i	The zero based index of the point to check.

Reimplemented in PolyObject, and TriObject.

                                         {
        return IsPointSelected(i) ? 1.0f : 0.0f;
    }

HasWeights()

virtual BOOL HasWeights ( )

inlinevirtual

Returns TRUE if the object has weights for its points that can be set; otherwise FALSE.

{ return FALSE; }

GetWeight()

virtual double GetWeight ( int  i )

inlinevirtual

Returns the weight of the specified point of the object.

Parameters

i	The point to return the weight of.

{ return 1.0; }

SetWeight()

virtual void SetWeight ( int  i, const double  w  )

inlinevirtual

Sets the weight of the specified point.

Parameters

i	The point whose weight to set.
w	The value to set.

{}

PolygonCount()

virtual BOOL PolygonCount ( TimeValue  t, int &  numFaces, int &  numVerts  )

inlinevirtual

Retreives the number of faces and vertices of the polyginal mesh representation of this object.

If this method returns FALSE then this functionality is not supported. Note: Plug-In developers should use the global function GetPolygonCount(Object*, int&, int&) to retrieve the number f vertices and faces in an arbitrary object.

Parameters

t	The time at which to compute the number of faces and vertices.
numFaces	The number of faces is returned here.
numVerts	The number of vertices is returned here.

Returns

TRUE if the method is fully implemented; otherwise FALSE.

Reimplemented in PatchObject, PolyObject, SimpleObjectBase, TriObject, and SimplePolyObject.

{ return FALSE; }

PointsWereChanged()

virtual void PointsWereChanged ( )

inlinevirtual

Informs the object that its points have been deformed, so it can invalidate its cache.

A developer who uses the GetPoint() / SetPoint() approach to modifying an object will call PointsWereChanged() to invalidate the object's cache. For example, if a modifier calls SetPoint(), when it is finished it should call this method so the object can invalidate and/or update its bounding box and any other data it might cache.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

{}

Deform()

virtual CoreExport void Deform ( Deformer *  defProc, int  useSel = 0  )

virtual

This is the method used to deform the object with a deformer.

The developer should loop through the object's points calling the defProc for each point (or each selected point if useSel is nonzero). The Deform() method is mostly a convenience. Modifiers can implement a 'Deformer' callback object which is passed to the Deform() method. The object then iterates through its points calling their deformer's callback for each point. The only difference between using the Deform() method as opposed to iterating through the points is that the Deform() method should respect sub-object selection. For example, the TriObject's implementation of Deform() iterates through its vertices, if the TriObject's selection level is set to vertex then it only calls the Deformer's callback for vertices that are selected. This way modifiers can be written that can be applied only to selection sets without any specific code to check selected points. The default implementation of this method just iterates through all points using GetPoint(i) and SetPoint(i). If an object supports sub-object selection sets then it should override this method.

Parameters

defProc	A pointer to an instance of the Deformer class. This is the callback object that actually performs the deformation.
useSel	A flag to indicate if the object should use the selected points only. If nonzero the selected points are used; otherwise all the points of the object are used.

Default Implementation:

void Object::Deform(Deformer *defProc,int useSel)
{
    int nv = NumPoints();
    for (int i=0; i<nv; i++)
        SetPoint(i,defProc->Map(i,GetPoint(i)));
    PointsWereChanged();
}

Sample Code:

This code shows the TriObject implementation of this method. Note how it looks at the useSel parameter to only call the selected points if required.

void TriObject::Deform(Deformer *defProc,int useSel)
{
    int nv = NumPoints();
    int i;
    if ( useSel ) {
        BitArray sel = mesh.VertexTempSel();
        float *vssel = mesh.getVSelectionWeights ();
        if (vssel) {
            for (i=0; i<nv; i++) {
                if(sel[i]) {
                    SetPoint(i,defProc->Map(i,GetPoint(i)));
                    continue;
                }
                if (vssel[i]==0) continue;
                Point3 & A = GetPoint(i);
                Point3 dir = defProc->Map(i,A) - A;
                SetPoint(i,A+vssel[i]*dir);
            }
        }
        else {
            for (i=0; i<nv; i++) if (sel[i])
                SetPoint(i,defProc->Map(i,GetPoint(i)));
        }
    }
    else {
        for (i=0; i<nv; i++)
            SetPoint(i,defProc->Map(i,GetPoint(i)));
    }
    PointsWereChanged();
}

Reimplemented in LinearShape, PatchObject, SplineShape, TriObject, and PolyObject.

GetDeformBBox()

virtual CoreExport void GetDeformBBox ( TimeValue  t, Box3 &  box, Matrix3 *  tm = NULL, BOOL  useSel = FALSE  )

virtual

This method computes the bounding box in the objects local coordinates or the optional space defined by tm.

Note: If you are looking for a precise bounding box, use this method and pass in the node's object TM (INode::GetObjectTM()) as the matrix.

Parameters

t	The time to compute the box.
box	A reference to a box the result is stored in.
tm	This is an alternate coordinate system used to compute the box. If the tm is not NULL this matrix should be used in the computation of the result.
useSel	If TRUE, the bounding box of selected sub-elements should be computed; otherwise the entire object should be used.

Reimplemented in MSHelperXtnd, MSLightXtnd, MSCameraXtnd, DummyObject, GizmoObject, SimpleManipulator, SimpleObjectBase, SimpleWSMObject, SimpleParticle, SimpleShape, SimpleSpline, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSSimpleObjectXtnd, SimplePolyObject, LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

IsMappable()

virtual int IsMappable ( )

inlinevirtual

This method lets you know if the ApplyUVWMap() method is available for this object.

This is used by things like the UVW mapping modifier, so that it can determine which objects can have their mapping modified. Returns nonzero if the object is mappable; otherwise zero.

Reimplemented in PatchObject, PolyObject, and TriObject.

{ return 0; }

NumMapChannels()

virtual int NumMapChannels ( )

inlinevirtual

Returns the maximum number of channels supported by this type of object.

TriObjects for instance return MAX_MESHMAPS which is currently set to 100.

Reimplemented in PatchObject, PolyObject, and TriObject.

{ return IsMappable(); }    // returns number possible.

NumMapsUsed()

virtual int NumMapsUsed ( )

inlinevirtual

Returns the number of maps currently used by this object.

This is at least 1+(highest channel in use). This is used so a plug-in that does something to all map channels doesn't always have to do it to every channel up to MAX_MESHMAPS but rather only to this value.

Reimplemented in PatchObject, PolyObject, and TriObject.

{ return NumMapChannels(); }    // at least 1+(highest channel in use).

ApplyUVWMap()

virtual void ApplyUVWMap ( int  type, float  utile, float  vtile, float  wtile, int  uflip, int  vflip, int  wflip, int  cap, const Matrix3 &  tm, int  channel = 1  )

inlinevirtual

This method may be called to map the object with UVW mapping coordinates.

If the object returns nonzero from IsMappable() then this method should be implemented.

Parameters

type	The mapping type. One of the following values: MAP_PLANAR MAP_CYLINDRICAL MAP_SPHERICAL MAP_BALL MAP_BOX
utile	Number of tiles in the U direction.
vtile	Number of tiles in the V direction.
wtile	Number of tiles in the W direction.
uflip	If nonzero the U values are mirrored.
vflip	If nonzero the V values are mirrored.
wflip	If nonzero the W values are mirrored.
cap	This is used with MAP_CYLINDRICAL. If nonzero, then any face normal that is pointing more vertically than horizontally will be mapped using planar coordinates.
tm	This defines the mapping space. As each point is mapped, it is multiplied by this matrix, and then it is mapped.
channel	This indicates which channel the mapping is applied to. See Mapping Channels .

Reimplemented in PatchObject, PolyObject, and TriObject.

                                         {}

CanConvertToType()

virtual CoreExport int CanConvertToType ( Class_ID  obtype )

virtual

Indicates whether the object can be converted to the specified type.

If the object returns nonzero to indicate it can be converted to the specified type, it must handle converting to and returning an object of that type from ConvertToType(). Note that all overrides of this method should either call _super::CanConvertToType or test to see if obtype == anyObjectClassID. If true, the method should return true.

See also

Class ObjectConverter for additional details on converting objects between types.

Parameters

obtype

The Class_ID of the type of object to convert to. See Class Class_ID, Class IDs defined in plugapi.h.

Returns

Nonzero if the object can be converted to the specified type; otherwise 0.

Reimplemented in GizmoObject, LinearShape, PatchObject, PolyObject, SimpleObjectBase, SimpleParticle, SimpleShape, SimpleSpline, SplineShape, TriObject, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSSimpleObjectXtnd, and SimplePolyObject.

ConvertToType()

virtual CoreExport Object * ConvertToType ( TimeValue  t, Class_ID  obtype  )

virtual

This method converts this object to the type specified and returns a pointer it.

Note that if ConvertToType() returns a new object it should be a completely different object with no ties (pointers or references) to the original. Note that all overrides of this method should either call _super::ConvertToType or test to see if obtype == anyObjectClassID. If true, the object should return itself.

See also

class ObjectConverter for additional details on converting objects between types.

The following is an issue that developers of world space modifiers need to

be aware of if the world space modifier specifies anything but generic deformable objects as its input type. In other words, if a world space modifier, in its implementation of Modifier::InputType(), doesn't specifically return defObjectClassID then the following issue regarding the 3ds Max pipeline needs to be considered. Developers of other plug-ins that don't meet this condition don't need to be concerned with this issue.

World space modifiers that work on anything other than generic deformable

objects are responsible for transforming the points of the object they modify into world space using the ObjectState TM. To understand why this is necessary, consider how 3ds Max applies the node transformation to the object flowing down the pipeline.

In the geometry pipeline architecture, the node in the scene has its

transformation applied to the object in the pipeline at the transition between the last object space modifier and the first world space modifier. The node transformation is what places the object in the scene – thus this is what puts the object in world space. The system does this by transforming the points of the object in the pipeline by the node transformation. This is only possible however for deformable objects. Deformable objects are those that support the Object::IsDeformable(), NumPoints(), GetPoint() and SetPoint() methods. These deformable objects can be deformed by the system using these methods, and thus the system can modify the points to put them in world space itself.

If a world space modifier does not specify that it works on deformable

objects, the system is unable to transform the points of the object into world space. What it does instead is apply the transformation to the ObjectState TM. In this case, a world space modifier is responsible for transforming the points of the object into world space itself, and then setting the ObjectState TM to the identity. There is an example of this in the sample code for the Bomb space warp. The Bomb operates on TriObjects and implements InputType() as { return Class_ID(TRIOBJ_CLASS_ID,0); }. Since it doesn't specifically return defObjectClassID, it is thus responsible for transforming the points of the object into world space itself. It does this in its implementation of ModifyObject() as follows:

if (os->GetTM())
{
    Matrix3 tm = *(os->GetTM());
    for (int i=0; i<triOb->mesh.getNumVerts(); i++) {
        triOb->mesh.verts[i] = triOb->mesh.verts[i] *tm;
    }
    os->obj->UpdateValidity(GEOM_CHAN_NUM,os->tmValid());
    os->SetTM(NULL,FOREVER);
}

As the code above shows, the Bomb checks if the ObjectState TM is non-NULL. If it is, the points of the object are still not in world space and thus must be transformed. It does this by looping through the points of the TriObject and multiplying each point by the ObjectState TM. When it is done, it sets the ObjectState TM to NULL to indicate the points are now in world space. This ensure that any later WSMs will not transform the points with this matrix again.

For the Bomb world space modifier this is not a problem since it specifies

in its implementation of ChannelsChanged() that it will operate on the geometry channel (GEOM_CHANNEL). Certain world space modifiers may not normally specify GEOM_CHANNEL in their implementation of ChannelsChanged(). Consider the camera mapping world space modifier. Its function is to apply mapping coordinates to the object it is applied to. Thus it would normally only specify TEXMAP_CHANNEL for ChannelsChanged(). However, since it operates directly on TriObjects, just like the Bomb, the system cannot transform the points into world space, and therefore the camera mapping modifier must do so in its implementation of ModifyObject(). But since it is actually altering the points of the object by putting them into world space it is altering the geometry channel. Therefore, it should really specify GEOM_CHANNEL | TEXMAP_CHANNEL in its implementation of ChannelsChanged(). If it didn't do this, but went ahead and modified the points of the object anyway, it would be transforming not copies of the points, but the original points stored back in an earlier cache or even the base object.

This is the issue developers need to be aware of. To state this in simple

terms then: Any world space modifier that needs to put the points of the object into world space (since it doesn't implement InputType() as defObjectClassID) needs to specify GEOM_CHANNEL in its implementation of ChannelsChanged().

Parameters

t	The time at which to convert.
obtype	The Class_ID of the type of object to convert to. See Class Class_ID, Class IDs defined in plugapi.h.

Returns

A pointer to an object of type obtype.

Default Implementation:

{ return NULL; }

Sample Code:

The following code shows how a TriObject can be retrieved from a node. Note on the code that if you call ConvertToType() on an object and it returns a pointer other than itself, you are responsible for deleting that object.

// Retrieve the TriObject from the node
int deleteIt;
TriObject *triObject = GetTriObjectFromNode(ip->GetSelNode(0),deleteIt);
// Use the TriObject if available
if (!triObject) return;
// ...
// Delete it when done...
if (deleteIt) triObject->DeleteMe();
 
// Return a pointer to a TriObject given an INode or return NULL
// if the node cannot be converted to a TriObject
TriObject *Utility::GetTriObjectFromNode(INode *node, int &deleteIt)
{
    deleteIt = FALSE;
    Object *obj = node->EvalWorldState(0).obj;
    if (obj->CanConvertToType(Class_ID(TRIOBJ_CLASS_ID, 0))) {
        TriObject *tri = (TriObject *) obj->ConvertToType(0,Class_ID(TRIOBJ_CLASS_ID, 0));
// Note that the TriObject should only be deleted
// if the pointer to it is not equal to the object
// pointer that called ConvertToType()
        if (obj != tri) 
            deleteIt = TRUE;
        return tri;
    }
    else {
        return NULL;
    }
}

Reimplemented in GizmoObject, LinearShape, PatchObject, PolyObject, SimpleObjectBase, SimpleParticle, SimpleShape, SimpleSpline, SplineShape, TriObject, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSSimpleObjectXtnd, and SimplePolyObject.

PreferredCollapseType()

virtual Class_ID PreferredCollapseType ( )

inlinevirtual

This method allows objects to specify the class that is the best class to convert to when the user collapses the stack.

The main base classes have default implementations. For example, GeomObject specifies TriObjects as its preferred collapse type and shapes specify splines as their preferred collapse type

Returns

The Class_ID of the preferred object type. See Class IDs defined in plugapi.h.

Reimplemented in MSPluginShape, MSShapeXtnd, GeomObject, and ShapeObject.

{return Class_ID(0,0);}

GetCollapseTypes()

virtual CoreExport void GetCollapseTypes ( Tab< Class_ID > &  clist, Tab< MSTR * > &  nlist  )

virtual

When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented.

The use may click on one of these choices to collapse the object into one of these types (for instance, an Editable Mesh or an Editable NURBS object). This method returns a list of Class_IDs and descriptive strings that specify the allowable types of objects that this object may be collapsed into. Note: Most plug-ins call the base class method in Object in their implementation of this method. The base class implementation provided by Object checks if the object can convert to both an editable mesh and an editable spline. If it can, these are added to the allowable types.

Parameters

clist	The table of allowable Class_IDs.
nlist	The table of pointers to strings that correspond to the table of Class_IDs above.

Sample Code:

void SphereObject::GetCollapseTypes(Tab<Class_ID> &clist,Tab<MSTR*>&nlist)
{
    Object::GetCollapseTypes(clist, nlist);
    Class_ID id = EDITABLE_SURF_CLASS_ID;
    MSTR *name = new MSTR(GetString(IDS_SM_NURBS_SURFACE));
    clist.Append(1,&id);
    nlist.Append(1,&name);
}

Reimplemented in PatchObject, SimpleSpline, SplineShape, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, and MSSimpleObjectXtnd.

CollapseObject()

virtual Object * CollapseObject ( )

inlinevirtual

This method is called on the world space cache object when the stack gets collapsed, that lets the pipeline object decide, if it wants to return a different object than itself.

The default implementation simply returns this. A PolyObject e.g. can create and return an EditablePolyObject in this method, so that the collapsed object has a UI. I only implemented this method for PolyObject, but this can potentially implemented that way for all pipeline objects, that currently pass up the editable version. It is important, that all places, that collapse the stack are calling this method after evaluating the stack.

It also is important, that the editable version implements this method to

simply return this, otherwise you'll get a non-editable object when you collapse an editable polyobject.

Returns

A pointer to the resulting object.

Reimplemented in PolyObject.

{ return this;}

GetSubselState()

virtual DWORD GetSubselState ( )

inlinevirtual

For objects that have sub selection levels, this method returns the current selection level of the object.

For example, a TriObject has the following selection levels: object, vertex, face, edge. Other object types may have different selection levels. The only standard is that a value of 0 indicates object level. b>

Returns

The current selection level of the object.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

{return 0;} 

SetSubSelState()

virtual void SetSubSelState ( DWORD  s )

inlinevirtual

Implemented by the System.

This method locks the object as a whole. The object defaults to not modifiable.

Reimplemented in PolyObject, and TriObject.

{}

ReadyChannelsForMod()

CoreExport void ReadyChannelsForMod

(

ChannelMask

channels

)

Implemented by the System.

If the requested channels are locked, this method will replace their data

with a copy and unlock them, otherwise it leaves them alone.

Parameters

channels

The channels to ready for modification.

ChannelValidity()

virtual CoreExport Interval ChannelValidity ( TimeValue  t, int  nchan  )

virtual

Retrieve the current validity interval for the nchan channel of the object.

Note

Most procedural objects won't implement this method since they don't have individual channels. Developers wanting to get the validity interval for a procedural object should use Object::ObjectValidity() instead.

Parameters

t	The time to retrieve the validity interval of the channel.
nchan	Specifies the channel to return the validity interval of. See Object Channels.

Returns

The validity interval of the specified channel.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

SetChannelValidity()

virtual CoreExport void SetChannelValidity ( int  nchan, Interval  v  )

virtual

Sets the validity interval of the specified channel.

Parameters

nchan	Specifies the channel. See Object Channels.
v	The validity interval for the channel.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

InvalidateChannels()

virtual CoreExport void InvalidateChannels ( ChannelMask  channels )

virtual

This method invalidates the intervals for the given channel mask.

This just sets the validity intervals to empty (calling SetEmpty() on the interval).

Parameters

channels

Specifies the channels to invalidate.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

ObjectValidity()

virtual CoreExport Interval ObjectValidity ( TimeValue  t )

virtual

This method returns the validity interval of the object as a whole at the specified time.

Parameters

t	The time to compute the validity interval.

Returns

The validity interval of the object, including that queried from the base class.

Reimplemented in DummyObject, GizmoObject, SphereGizmoObject, CylGizmoObject, BoxGizmoObject, LinearShape, SimpleManipulator, PatchObject, PolyObject, SimpleObjectBase, SimpleWSMObject, SimpleParticle, SimpleShape, SimpleSpline, SplineShape, TriObject, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSHelperXtnd, MSSimpleObjectXtnd, and SimplePolyObject.

MakeShallowCopy()

virtual Object * MakeShallowCopy ( ChannelMask  channels )

inlinevirtual

This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels.

It must also copy the validity intervals of the copied channels, and invalidate the other intervals.

Parameters

channels

The channels to copy.

Returns

A pointer to the shallow copy of the object.

Reimplemented in LinearShape, PatchObject, PolyObject, SimpleParticle, SplineShape, TriObject, and MSShapeXtnd.

{ return NULL; }

ShallowCopy()

virtual CoreExport void ShallowCopy ( Object *  fromOb, ChannelMask  channels  )

virtual

This method copies the specified channels from the fromOb to this and copies the validity intervals.

A plug-in needs to copy the specified channels from the specified object fromOb to itself by just copying pointers (not actually copying the data). No new memory is typically allocated, this method is just copying the pointers.

Parameters

fromOb	Object to copy the channels from.
channels	Channels to copy.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, TriObject, and MSShapeXtnd.

FreeChannels()

virtual CoreExport void FreeChannels ( ChannelMask  channels )

virtual

This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty).

Parameters

channels

Specifies the channels to free.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

NewAndCopyChannels()

virtual CoreExport void NewAndCopyChannels ( ChannelMask  channels )

virtual

This method replaces the locked channels with newly allocated copies.

It will only be called if the channel is locked.

Parameters

channels

The channels to be allocate and copy.

Reimplemented in LinearShape, PatchObject, PolyObject, SplineShape, and TriObject.

MaybeEnlargeViewportRect()

virtual CoreExport void MaybeEnlargeViewportRect ( GraphicsWindow *  gw, Rect &  rect  )

virtual

This method allows the object to enlarge its viewport rectangle, if it wants to.

The system will call this method for all objects when calculating the viewport rectangle; the object can enlarge the rectangle if desired. This is used by the Editable Spline code to allow extra room for vertex serial numbers, which can extend outside the normal bounding rectangle.

Parameters

gw	Points to the GraphicsWindow associated with the viewport.
rect	The enlarged rectangle is returned here.

Default Implementation:

{}

Sample Code:

void SplineShape::MaybeEnlargeViewportRect(GraphicsWindow *gw, Rect &rect)
{
    if(!showVertNumbers)
        return;
    MCHAR dummy[256];
    SIZE size;
    int maxverts = -1;
    for(int i = 0; i < shape.splineCount; ++i) {
        int verts = shape.splines[i]->KnotCount();
        if(verts > maxverts)
            maxverts = verts;
    }
    sprintf(dummy,"%d",maxverts);
    gw->getTextExtents(dummy, &size);
    rect.SetW(rect.w() + size.cx);
    rect.SetY(rect.y() - size.cy);
    rect.SetH(rect.h() + size.cy);
}

Reimplemented in SplineShape.

IsBaseClassOwnedChannel()

CoreExport bool IsBaseClassOwnedChannel ( int  nchan )

inline

Implemented by the System.

This method locks the object as a whole. The object defaults to not modifiable.

{ return (nchan == EXTENSION_CHAN_NUM) ? true : false;}

UpdateValidity()

CoreExport void UpdateValidity	(	int	nchan,
		Interval	v
	)

When a modifier is applied to an object, it needs to include its own validity interval in the interval of the object.

To do this, a modifier calls the UpdateValidity() method of an object. This method intersects interval v to the nchan channel validity of the object.

Parameters

nchan	The validity interval of the modifier is intersected with this channel of the object. See Object Channels.
v	The interval to intersect.

GetNoEvalInterval()

Interval GetNoEvalInterval ( )

inline

This method is used internally.

{ return noEvalInterval; }

SetNoEvalInterval()

void SetNoEvalInterval ( Interval  iv )

inline

This method is used internally.

{noEvalInterval = iv; }

ReduceCaches()

virtual CoreExport void ReduceCaches ( TimeValue  t )

virtual

This method give the object the chance to reduce its caches.

Parameters

t	The time to discard any caches the object has.

IsConstObject()

virtual int IsConstObject ( )

inlinevirtual

This is called to determine if this is a construction object or not.

Returns

Nonzero if the object is a construction object; otherwise 0.

Reimplemented in ConstObject.

{ return 0; }  

NumPipeBranches()

virtual int NumPipeBranches ( bool  selected = true )

inlinevirtual

This method returns the number of pipeline branches combined by the object.

This is not the total number of branches, but rather the number that are active. For example in the boolean object, if the user does not have any operands selected, this methods would return zero. If they have one selected it would return one.

Parameters

selected

This parameter must be supported by all compound objects. In case the selected parameter is true the object should only return the number of pipebranches, that are currently selected in the UI (this is the way it worked in R3 and before. In case this parameter is false, the object has to return the number of all branches, no matter if they are selected or not

{return 0;}

GetPipeBranch()

virtual Object * GetPipeBranch ( int  i, bool  selected = true  )

inlinevirtual

Retrieves sub-object branches from an object that supports branching.

Certain objects combine a series of input objects (pipelines) into a single object. These objects act as a multiplexer allowing the user to decide which branch(s) they want to see the history for. It is up to the object how they want to let the user choose. For example the object may use sub-object selection to allow the user to pick a set of objects for which the common history will be displayed. When the history changes for any reason, the object should send a notification (REFMSG_BRANCHED_HISTORY_CHANGED) using NotifyDependents().

Parameters

i	The branch index.
selected	This parameter must be supported by all compound objects. In case the selected parameter is true the object should only return the number of pipebranches, that are currently selected in the UI (this is the way it worked in R3 and before. In case this parameter is false, the object has to return the number of all branches, no matter if they are selected or not

Returns

The 'i-th' sub-object branch.

{return NULL;}

GetBranchINode()

virtual INode * GetBranchINode ( TimeValue  t, INode *  node, int  i, bool  selected = true  )

inlinevirtual

When an object has sub-object branches, it is likely that the sub-objects are transformed relative to the object.

This method gives the object a chance to modify the node's transformation so that operations (like edit modifiers) will work correctly when editing the history of the sub object branch. An object can implement this method by returning a pointer to a new INodeTransformed that is based on the node passed into this method. See Class INodeTransformed.

Parameters

t	The time to get the INode.
node	The original INode pointer.
i	The branch index.
selected	This parameter must be supported by all compound objects. In case the selected parameter is true the object should only return the number of pipebranches, that are currently selected in the UI (this is the way it worked in R3 and before. In case this parameter is false, the object has to return the number of all branches, no matter if they are selected or not

Returns

A pointer to an INode. This can be the original passed in (the default implementation does this) or a new INodeTransformed.

{return node;}

NumberOfContainedShapes()

virtual int NumberOfContainedShapes ( )

inlinevirtual

Returns the number of shapes contained inside this object.

A shape container may return zero if it doesn't currently have any shapes.

Returns

The number of shapes. A return value of -1 indicates this is not a container.

{ return -1; }    // NOT a container!

GetContainedShape()

virtual ShapeObject * GetContainedShape ( TimeValue  t, int  index  )

inlinevirtual

This method returns the ShapeObject specified by the index passed at the time specified.

See Class ShapeObject.

Parameters

t	The time to return the shape.
index	The index of the shape.

{ return NULL; }

GetContainedShapeMatrix()

virtual void GetContainedShapeMatrix ( TimeValue  t, int  index, Matrix3 &  mat  )

inlinevirtual

Returns the matrix associated with the shape whose index is passed.

This matrix contains the offset within the object used to align the shape viewport to the shape.

Parameters

t	The time to return the matrix.
index	The index of the shape whose matrix to return.
mat	The matrix is returned here.

{}

ContainedShapeSelectionArray()

virtual BitArray ContainedShapeSelectionArray ( )

inlinevirtual

This is used by the lofter.

The lofter can have several shapes selected, and the bit array returned here will have a bit set for each selected shape. See Class BitArray.

Returns

{ return BitArray(); }

IsShapeObject()

virtual BOOL IsShapeObject ( )

inlinevirtual

Returns the number of shapes contained inside this object.

A shape container may return zero if it doesn't currently have any shapes.

Returns

The number of shapes. A return value of -1 indicates this is not a container.

Reimplemented in ShapeObject.

{ return FALSE; }

CheckObjectIntegrity()

virtual BOOL CheckObjectIntegrity ( )

inlinevirtual

This method is used for debugging only.

The TriObject implements this method by making sure its face's vert indices are all valid.

Returns

TRUE if valid; otherwise FALSE.

Reimplemented in PolyObject, and TriObject.

{return TRUE;}              

HasUVW() [1/2]

virtual BOOL HasUVW ( )

inlineoverridevirtual

Call this method to find out if the object has UVW coordinates.

This method returns TRUE if the object has UVW coordinates; otherwise FALSE. In 3ds Max 2.0 and later there is code in the renderer that will automatically turn on the UVW coordinates of the base object if UV's are missing (and needed). The base object has to implement two simple methods to make this work: HasUVW() and SetGenUVW(). Developers are encouraged to put these methods in their objects: it makes using the program easier for the user. If they are not implemented, it doesn't cause any real harm: it will just operate as before and put up the missing UVW's message. Here is how the procedural sphere implements these methods:

BOOL SphereObject::GetGenUVW()
{
    BOOL genUVs;
    Interval v;
    pblock->GetValue(PB_GENUVS, 0, genUVs, v);
    return genUVs;
}
 
void SphereObject::SetGenUVW(BOOL sw)
{
    if (sw==GetGenUVW()) return;
    pblock->SetValue(PB_GENUVS,0, sw);
}

Important Note: The pblock->SetValue() will cause a call to NotifyDependents(FOREVER, PART_TEXMAP, REFMSG_CHANGE), which will invalidate the UVW cache. It is essential that this call be made, so if the 'generate UVW' boolean is not handled by a parameter block, then NotifyDependents() needs to be called explicitly. Also Note: For "modifiable objects" that pass up the pipeline getting modified, such as TriObject, EditTriObject, etc., which cannot generate their own UVWs, but can carry them in their data structures, only this HasUVW() method needs to be implemented. For example, here is the implementation for TriObject: BOOL TriObject::HasUVW() { return mesh.tvFace?1:0; }

Reimplemented from BaseObject.

Reimplemented in PolyObject, TriObject, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSPluginShape, MSShapeXtnd, MSPluginSimpleObject, MSSimpleObjectXtnd, MSPluginSimpleSpline, MSSimpleManipulatorXtnd, and ShapeObject.

{ return 0; }

HasUVW() [2/2]

virtual BOOL HasUVW ( int  mapChannel )

inlineoverridevirtual

Call this method to find out if the object is has UVW coordinates for the specified mapping channel.

This method returns TRUE if the object has UVW coordinates; otherwise FALSE. See the method HasUVW() above for more details.

Parameters

mapChannel

See Mapping Channels.

Reimplemented from BaseObject.

Reimplemented in PolyObject, TriObject, and ShapeObject.

{ return (mapChannel==1) ? HasUVW() : FALSE; }

FindBaseObject()

virtual Object * FindBaseObject ( )

inlinevirtual

It is called to return a pointer to the base object (an object that is not a derived object).

This method is overridden by DerivedObjects to search down the pipeline for the base object. The default implementation just returns this. This function is still implemented by derived objects and WSM's to search down the pipeline. This allows you to just call it on a nodes ObjectRef without checking for type.

{ return this;  }

IsParamSurface()

virtual BOOL IsParamSurface ( )

inlinevirtual

There are several methods used to access a parametric position on the surface of the object.

If this method returns TRUE then Object::GetSurfacePoint() will be called to return a point on the surface that corresponds to the u and v parameters passed to it. If this method returns FALSE then it is assumed the object does not support returning a point on the surface based on parameteric values. For sample code see /MAXSDK/SAMPLES/OBJECTS/SPHERE.CPP. If the object has several parametric surfaces then a second version of GetSurfacePoint() with an integer which specifies which surface will be called.

Reimplemented in PatchObject.

{return FALSE;}

NumSurfaces()

virtual int NumSurfaces ( TimeValue  t )

inlinevirtual

Returns the number of parametric surfaces within the object.

Parameters

t	The time at which to check.

{return 1;}

GetSurfacePoint() [1/2]

virtual Point3 GetSurfacePoint ( TimeValue  t, float  u, float  v, Interval &  iv  )

inlinevirtual

This method needs to be implemented if Object::IsParamSurface() returns TRUE.

This method is used to retrieve a point on the surface of the object based on two parameters of the surface, u and v. Note: This method assumes there is a single parametric surface. If there is more than 1 (NumSurfaces() returns > 1, use the GetSurface() method below which allows for multiple surfaces.

Parameters

t	The time to retrieve the point.
u	The parameter along the horizontal axis of the surface.
v	The parameter along the vertical axis of the surface.
iv	This interval is updated based on the interval of the surface parameter.

Reimplemented in PatchObject.

{return Point3(0,0,0);}

GetSurfacePoint() [2/2]

virtual Point3 GetSurfacePoint ( TimeValue  t, int  surface, float  u, float  v, Interval &  iv  )

inlinevirtual

This method is used to retrieve a point on the specified surface of the object based on two parameters of the surface, u and v.

Parameters

t	The time to retrieve the point.
surface	The zero based index of the surface. This number is >=0 and <NumSurfaces().
u	The parameter along the horizontal axis of the surface.
v	The parameter along the vertical axis of the surface.
iv	This interval is updated based on the interval of the surface parameter.

{return Point3(0,0,0);}

SurfaceClosed()

virtual void SurfaceClosed ( TimeValue  t, int  surface, BOOL &  uClosed, BOOL &  vClosed  )

inlinevirtual

This method allows the object to return flags that indicate whether the parametric surface is closed in the U and V dimensions.

Set the appropriate closure variables to TRUE if the surface is closed in that direction, FALSE if it is not. A torus, for example, is closed in both directions.

Parameters

t	The time to check the surface.
surface	The zero based index of the surface. This number is >=0 and <NumSurfaces().
uClosed	Set to TRUE if the surface is closed in U; otherwise to FALSE.
vClosed	Set to TRUE if the surface is closed in V; otherwise to FALSE.

{uClosed = vClosed = TRUE;}

GetExtendedProperties()

virtual BOOL GetExtendedProperties ( TimeValue  t, MSTR &  prop1Label, MSTR &  prop1Data, MSTR &  prop2Label, MSTR &  prop2Data  )

inlinevirtual

This method allows an object to return extended Properties fields.

It is called when the Object Properties dialog is being prepared. If you don't want to display any extended properties, simply return FALSE. To display extended property fields, place the field label in the appropriate label string and the display value in a formatted string. Two fields are supplied, each with a label and a data string; if only using one, make the second label field and data field blank (""). Return TRUE to indicate you have filled in the fields. The properties dialog will display your returned values.

Parameters

t	The time at which the strings are requested.
prop1Label	The string for the property 1 label.
prop1Data	The formatted data string to appear as property 1.
prop2Label	The string for the property 2 label.
prop2Data	The formatted data string to appear as property 2.

Returns

TRUE if this method is implemented and the fields are filled in; otherwise FALSE.

Reimplemented in PatchObject, MSPluginShape, MSShapeXtnd, and ShapeObject.

{return FALSE;}

SvTraverseAnimGraph()

CoreExport SvGraphNodeReference SvTraverseAnimGraph ( IGraphObjectManager *  gom, Animatable *  owner, int  id, DWORD  flags  )

virtual

Remarks

This method is available in release 3.0 and later only.

This method traverses the graph of objects in the 3ds Max scene, adding desired objects to the schematic view. Developers can specialize this behaviour by overriding this method and adding whatever objects are interesting to the schematic view. Objects are added to the schematic view by calling IGraphObjectManager::AddAnimatable(...). Reference lines are added to the schematic view by calling IGraphObjectManager::AddReference(...). Implementers of this method should call it recursively to process other objects in the scene.

See Class IGraphObjectManager.

Parameters

gom	Points to the schematic view window manager.
owner	The owning animatable.
id	This is usually the sub-anim number (but can actually be any value the developer chooses).
flags	See Flags for AddAnimatable() and SvTravereseAnimGraph().

Returns

A SvGraphNodeReference object.

Reimplemented from Animatable.

SvHandleDoubleClick()

CoreExport bool SvHandleDoubleClick ( IGraphObjectManager *  gom, IGraphNode *  gNode  )

virtual

Remarks

This method is available in release 3.0 and later only.

This method is called when this node is double-clicked in the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to the node in the schematic view.

Returns

true is handled; false if not interested in the event.

Default Implementation:

{ return false; }

Reimplemented from Animatable.

SvGetName()

CoreExport MSTR SvGetName ( IGraphObjectManager *  gom, IGraphNode *  gNode, bool  isBeingEdited  )

virtual

Remarks

Returns the name of the object as it appears in the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.
isBeingEdited	TRUE if the item is being edited; FALSE if not.

Default Implementation:

{
    Animatable *owner;
    int subNum;
    MSTR name;
    owner = gNode->GetOwner();
    subNum = gNode->GetID();
    name = owner->SubAnimName(subNum);
    return name;
}

Reimplemented from Animatable.

SvHighlightColor()

CoreExport COLORREF SvHighlightColor ( IGraphObjectManager *  gom, IGraphNode *  gNode  )

virtual

Remarks

This method is available in release 3.0 and later only.

Returns the highlight color for this node. The highlight color is used to outline nodes in the schematic view when SvIsHighlighted(...) returns true.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.

Returns

See COLORREF-DWORD format.

Default Implementation:

{ return gom->SvGetUIColor(SV_UICLR_PLUGIN_HIGHLIGHT); }

Reimplemented from Animatable.

SvIsSelected()

CoreExport bool SvIsSelected ( IGraphObjectManager *  gom, IGraphNode *  gNode  )

virtual

Returns true if the object is selected in its schematic view.

Reimplemented from Animatable.

SvGetMultiSelectCallback()

CoreExport MultiSelectCallback * SvGetMultiSelectCallback ( IGraphObjectManager *  gom, IGraphNode *  gNode  )

virtual

Remarks

This method is called before a multiple select/deselect operation in the schematic view. Returns a callback used to perform the (de)selection. May return NULL if this object cannot be selected in some principle editor outside the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to the node in the schematic view.

Returns

A pointer to the callback object. See Class MultiSelectCallback.

Default Implementation:

{ return NULL; }

Reimplemented from Animatable.

SvCanSelect()

CoreExport bool SvCanSelect ( IGraphObjectManager *  gom, IGraphNode *  gNode  )

virtual

Remarks

Returns true if this object can be selected in some editor (viewport, material editor, plug-in specific editor, etc.). Selection is actually accomplished by via the SvGetMultiSelectCallback(...) mechanism described above.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to the node in the schematic view.

Default Implementation:

{ return false; }

Reimplemented from Animatable.

AddXTCObject()

CoreExport void AddXTCObject	(	XTCObject *	pObj,
		int	priority = 0,
		int	branchID = -1
	)

This method adds an extension object into the pipeline.

Implemented by the System.

Parameters

pObj	Points to the extension object to add.
priority	The priority of the object. The methods (XTCObject::Display(), PreChanChangedNotify() etc) of higher priority XTCObjects will be called before those of lower priority XTCObjects.
branchID	The branch identifier of the object.

NumXTCObjects()

CoreExport int NumXTCObjects

(

)

Returns the number of extension objects maintained by this Object.

Implemented by the System.

GetXTCObject()

CoreExport XTCObject * GetXTCObject

(

int

index

)

Returns a pointer to the specified extension object.

Implemented by the System.

Parameters

index

The zero based index of the extension object to return.

RemoveXTCObject()

CoreExport void RemoveXTCObject

(

int

index

)

Removes the extension object as indicated by the index.

Implemented by the System.

Parameters

index

The zero based index of the extension object to remove.

SetXTCObjectPriority()

CoreExport void SetXTCObjectPriority	(	int	index,
		int	priority
	)

Sets the priority for the extension object whose index is passed.

Implemented by the System.

Parameters

index	The zero based index of the extension object to remove.
priority	The new priority to assign.

GetXTCObjectPriority()

CoreExport int GetXTCObjectPriority

(

int

index

)

Returns the integer priority number of the extension object whose index is passed.

Implemented by the System.

Parameters

index

The zero based index of the extension object to check.

SetXTCObjectBranchID()

CoreExport void SetXTCObjectBranchID	(	int	index,
		int	branchID
	)

Sets the branch ID of the extension object whose index is passed.

Implemented by the System.

Parameters

index	The zero based index of the extension object whose branch ID is set.
branchID	The branch identifier to set.

GetXTCObjectBranchID()

CoreExport int GetXTCObjectBranchID

(

int

index

)

Returns the integer branch ID of the extension object whose index is passed.

Implemented by the System.

Parameters

index

The zero based index of the extension object whose branch ID is to be returned.

MergeAdditionalChannels()

CoreExport void MergeAdditionalChannels	(	Object *	from,
		int	branchID
	)

This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it).

Object *from is the object returned from Eval(os.obj). The branchID is an integer that specifies that branch. The extension channel will get a callback to XTCObject::RemoveXTCObjectOnMergeBranches() and XTCObject::MergeXTCObject(). By default it returns true to RemoveXTCObjectOnMergeBranches which means that the existing XTCObjects with that branchID will be deleted. The method MergeXTCObject simply copies the XTCObjects from the incoming branch into the compound object. Implemented by the System.

Parameters

from	The object to merge additional channels from.
branchID	The branch identifier to set.

BranchDeleted()

CoreExport void BranchDeleted	(	int	branchID,
		bool	reorderChannels
	)

This method has to be called on the CompoundObject so it can delete the XTCObjects for the specified branch.

The XTCObject will again have the final decision if the XTCObject gets really deleted or not in a callback to XTCObject::RemoveXTCObjectOnBranchDeleted() which will return true if the XTCOject should be removed. Implemented by the System.

Parameters

branchID	Specifies which brach of the compound object the extension objects are deleted from.
reorderChannels	TRUE to reorder the channels, otherwise FALSE.

CopyAdditionalChannels()

CoreExport void CopyAdditionalChannels	(	Object *	from,
		bool	deleteOld = true,
		bool	bShallowCopy = false
	)

This method copies all extension objects from the "from" object into the current object.

In case deleteOld is false the objects will be appended. If it is true the old XTCObjects will be deleted. Implemented by the System.

Parameters

from	The source object which contains extension objects.
deleteOld	If true the original objects are deleted after the copy; if false they remain after the copy.
bShallowCopy	If true only a ShallowCopy() is performed; if false a complete copy of the objects is done.

DeleteAllAdditionalChannels()

CoreExport void DeleteAllAdditionalChannels

(

)

Implemented by the System.

This method will delete all additional channels.

UseSelectionBrackets()

virtual BOOL UseSelectionBrackets ( )

inlinevirtual

This method allows an object to choose whether or not it will display selection brackets in shaded viewports.

The method will return FALSE if no selection brackets are displayed or TRUE if it does display selection brackets.

Reimplemented in SimpleManipulator.

{ return TRUE; }

IsManipulator()

virtual BOOL IsManipulator ( )

inlinevirtual

Reimplemented in Manipulator.

{ return FALSE; }

GetInterface() [1/2]

CoreExport void * GetInterface ( ULONG  id )

overridevirtual

Remarks

This method provides a mechanism for extending the class in the future. In 3ds Max 4.0 there are new interfaces that are accessed by passing an id to this method and it will respond by returning the corresponding interface pointer.

This method has been used however for a different purpose. It currently is used to determine if an object is of a particular class. With controllers for example, there is one base class Control, however there are many super classes (CTRL_FLOAT_CLASS_ID, CTRL_SCALE_CLASS_ID, etc.). If you wanted to find out if a given Animatable was a controller you would need to compare its SuperClassID to all the known types and only if it wasn't one of the known types could you be sure it wasn't a controller. Having to do this is inconvenient for a developer.

Instead the Control class implements this method. It looks at the id, and if it matches a predefined constant I_CONTROL, it returns its this pointer. In this way, given any Animatable, it is easy to find out if it is a controller by simply asking for the control interface. There is a macro that does this:

#define GetControlInterface(anim)
((Control*)anim-\>GetInterface(I_CONTROL))

A plug-in developer may use this macro as follows:

Control *c = GetControlInterface(anim);

This will either be NULL or a pointer to a valid controller.

Note: Plug-in defined interfaces should be greater than the following value:

#define I_USERINTERFACE 0x0000ffff

If a plug-in implements this method for its own purposes, it would, in general, switch on the id and if it is not aware of the id it would call this method on the base class. Otherwise it could respond to the id as it needed. See the sample code below for the how the Control class implements this method.

Parameters

id	The id of the interface.

Default Implementation:

{ return NULL; }

Sample Code:

The following is the Control class implementation of this method. It looks at the id passed, and if it matches I_CONTROL it returns its this pointer. Otherwise it calls the base class method.

void* Control::GetInterface(ULONG id)
{
    if (id==I_CONTROL) {
        return this;
    }
    else {
        return Animatable::GetInterface(id);
    }
}

Reimplemented from BaseObject.

Reimplemented in PatchObject, SimpleObjectBase, SimpleParticle, SplineShape, TriObject, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSSimpleObjectXtnd, MSSimpleManipulatorXtnd, IDerivedObject, LightObject, ShapeObject, WSMObject, SimplePolyObject, and SplineShape.

GetInterface() [2/2]

CoreExport BaseInterface * GetInterface ( Interface_ID  id )

overridevirtual

Remarks

Returns a pointer to the Base Interface for the interface ID passed. The default implementation of this method retrieves this information from the ClassDesc for the plug-in.

Any future object-based interfaces should be allocated unique Interface_IDs (you can use Gencid.exe for this) and made available through this call.

The default implementation of GetInterface(Interface_ID) looks up a standalone interface of the given ID on the object's ClassDesc. This gives access to standalone interfaces via any of a plug-in's objects, without having to dig around for the ClassDesc, so you should fall back to calling the default implementation if you don't recognize an ID in your implementation of GetInterface(Interface_ID).

Parameters

id	The unique ID of the interface to get. See Class Interface_ID.

Reimplemented from BaseObject.

Reimplemented in MSPluginSimpleManipulator, MSSimpleManipulatorXtnd, PFSimpleAction, PFSimpleOperator, PFSimpleTest, IXRefObject8, MSPluginObject< GenCamera >, MSPluginObject< GeomObject >, MSPluginObject< HelperObject >, MSPluginObject< GenLight >, MSPluginObject< ShapeObject >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GenLight, MSPluginLight >, MSObjectXtnd< ShapeObject, MSPluginShape >, IDerivedObject, LightObject, SimpleObjectBase, TriObject, ShapeObject, SimplePolyObject, and SplineShape.

ReduceDisplayCaches()

virtual void ReduceDisplayCaches ( )

inlinevirtual

Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it.

This function should delete any derived data used to display the object such as gfx normals, direct mesh caches etc.
Tnis is called when the user hides the node or sets it as bounding box

Reimplemented in PolyObject, and TriObject.

{  }

NeedGWCacheRebuilt()

virtual bool NeedGWCacheRebuilt ( GraphicsWindow *  gw, Material *  ma, int  numMat  )

inlinevirtual

This returns whether the Graphics Cache for this object needs to be rebuilt.

Parameters:

GraphicsWindow *gw the active graphics window
Material *ma the material aray assigned to the mesh
int numMat the number of materials in the material array

Reimplemented in PolyObject, and TriObject.

{ return false; }

BuildGWCache()

virtual void BuildGWCache ( GraphicsWindow *  gw, Material *  ma, int  numMat, BOOL  threaded  )

inlinevirtual

This builds the graphics window cached mesh.

Parameters:

GraphicsWindow *gw the active graphics window
Material *ma the material aray assigned to the mesh
int numMat the number of materials in the material array
BOOL threaded whether when building the cache it can use additional threads. This is needed since the system may be creating many meshes at the same time

Reimplemented in PolyObject, and TriObject.

{  }

StartStackEval()

virtual void StartStackEval ( )

inlinevirtual

This are called right before and after a modifier is applied to an object.

This allows for certain types of opitimizations to happens since durinng modifier modification the object knows what channels are changing and can do optimizations to speed things up like invalidating specific display channels which it does not know about when say a baseobject is evaluated.

Reimplemented in PolyObject, and TriObject.

{}

EndStackEval()

virtual void EndStackEval ( )

inlinevirtual

Reimplemented in PolyObject, and TriObject.

{}