#include <inode.h>

Class Description

See also: Class ReferenceTarget, Class FPMixinInterface, Class Interface, Class INodeTransformed, Class Material, Class Matrix3, Class Quat, Class AngAxis, Class Control, Class Object, Class INodeTab.

Description:: The INode class is the interface to nodes in the scene. It provides methods to access various parts of a node such as its name, transformation matrices, parents and children, display status, etc. All methods of this class are implemented by the system.

Inheritance diagram for INode:

Public Types
enum	{ getPosTaskWeight, getRotTaskWeight, setPosTaskWeight, setRotTaskWeight, setBoneNodeOnOff, setBoneNodeOnOffM, setBoneAutoAlign, setBoneFreezeLen, setBoneScaleType, getBoneNodeOnOff, getBoneAutoAlign, getBoneFreezeLen, getBoneScaleType, realignBoneToChild, resetBoneStretch, getStretchTM, getBoneAxis, getBoneAxisFlip, setBoneAxis, setBoneAxisFlip, setPrimaryVisibility, getPrimaryVisibility, setSecondaryVisibility, getSecondaryVisibility, setApplyAtmospherics, getApplyAtmospherics, getVertexColorType, setVertexColorType, getCVertMode, setCVertMode, getShadeCVerts, setShadeCVerts, getNodeHandle, getVertexColorMapChannel, setVertexColorMapChannel, isSceneXRefNode, kLastFPFuncID }

enum	{ boneScaleTypeEnum, boneAxisEnum, vertexColorTypeEnum }

Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
virtual void	InvalidateRect (TimeValue t, bool oldRect=false)=0

virtual void	UnhideObjectAndLayer (bool dolayer=true)
	Makes the node, and optionally the layer, visible in the scene. More...

virtual int	IsObjectHidden ()
	Returns the hidden state of this node in the scene. More...

virtual void	UnfreezeObjectAndLayer (bool dolayer=true)
	Unfreeze the node, and optionally its layer. More...

virtual int	IsObjectFrozen ()
	Test the frozen property of this node. More...

virtual int	HasObjectXRayMtl ()
	Get the X-Ray node property. More...

virtual void	IgnoreExtents (BOOL onOff)=0
	Ignore this node during zoom extents. More...

virtual int	GetIgnoreExtents ()=0
	Is this node ignored during zoom extents. More...

virtual bool	MayResetTransform ()=0

BaseInterface *	GetInterface (Interface_ID id)

FPInterfaceDesc *	GetDesc ()

	PROP_FNS (getPosTaskWeight, GetPosTaskWeight, setPosTaskWeight, SetPosTaskWeight, TYPE_FLOAT)

	PROP_FNS (getRotTaskWeight, GetRotTaskWeight, setRotTaskWeight, SetRotTaskWeight, TYPE_FLOAT)

	PROP_FNS (getBoneAutoAlign, GetBoneAutoAlign, setBoneAutoAlign, SetBoneAutoAlign, TYPE_BOOL)

	PROP_FNS (getBoneFreezeLen, GetBoneFreezeLen, setBoneFreezeLen, SetBoneFreezeLen, TYPE_BOOL)

	PROP_FNS (getBoneScaleType, GetBoneScaleType, setBoneScaleType, SetBoneScaleType, TYPE_ENUM)

	PROP_FNS (getBoneAxis, GetBoneAxis, setBoneAxis, SetBoneAxis, TYPE_ENUM)

	PROP_FNS (getBoneAxisFlip, GetBoneAxisFlip, setBoneAxisFlip, SetBoneAxisFlip, TYPE_BOOL)

	RO_PROP_TFN (getStretchTM, GetStretchTM, TYPE_MATRIX3_BV)

	PROP_TFNS (getBoneNodeOnOff, GetBoneNodeOnOff_T, setBoneNodeOnOff, SetBoneNodeOnOff, TYPE_BOOL)

	VFNT_1 (setBoneNodeOnOffM, SetBoneNodeOnOff, TYPE_BOOL)

	VFNT_0 (realignBoneToChild, RealignBoneToChild)

	VFNT_0 (resetBoneStretch, ResetBoneStretch)

	PROP_FNS (getPrimaryVisibility, GetPrimaryVisibility, setPrimaryVisibility, SetPrimaryVisibility, TYPE_bool)

	PROP_FNS (getSecondaryVisibility, GetSecondaryVisibility, setSecondaryVisibility, SetSecondaryVisibility, TYPE_bool)

	PROP_FNS (getApplyAtmospherics, ApplyAtmospherics, setApplyAtmospherics, SetApplyAtmospherics, TYPE_BOOL)

	PROP_FNS (getCVertMode, GetCVertMode, setCVertMode, SetCVertMode, TYPE_INT)

	PROP_FNS (getShadeCVerts, GetShadeCVerts, setShadeCVerts, SetShadeCVerts, TYPE_INT)

	PROP_FNS (getVertexColorType, GetVertexColorType, setVertexColorType, SetVertexColorType, TYPE_ENUM)

	PROP_FNS (getVertexColorMapChannel, GetVertexColorMapChannel, setVertexColorMapChannel, SetVertexColorMapChannel, TYPE_INT)

	RO_PROP_FN (getNodeHandle, GetHandle, TYPE_DWORD)

	RO_PROP_FN (isSceneXRefNode, IsSceneXRefNode, TYPE_bool)

INodeTransformed Methods

virtual void	DisposeTemporary ()

virtual INode *	GetActualINode ()

Node Identification

virtual const MCHAR *	GetName ()=0

virtual void	SetName (const MCHAR *s)=0

WStr	BuildHierarchyName (bool doQuoted=true, bool isRootIncluded=false)

virtual ULONG	GetHandle ()

Transformation Matrices
virtual Matrix3	GetNodeTM (TimeValue t, Interval *valid=NULL)=0

virtual void	SetNodeTM (TimeValue t, Matrix3 &tm)=0

virtual Matrix3	GetObjectTM (TimeValue time, Interval *valid=NULL)=0

virtual Matrix3	GetObjTMBeforeWSM (TimeValue time, Interval *valid=NULL)=0

virtual Matrix3	GetObjTMAfterWSM (TimeValue time, Interval *valid=NULL)=0

virtual BOOL	GetTransformLock (int type, int axis)=0

virtual void	SetTransformLock (int type, int axis, BOOL onOff)=0

virtual void	Move (TimeValue t, const Matrix3 &tmAxis, const Point3 &val, BOOL localOrigin=FALSE, BOOL affectKids=TRUE, int pivMode=PIV_NONE, BOOL ignoreLocks=FALSE)=0

virtual void	Rotate (TimeValue t, const Matrix3 &tmAxis, const AngAxis &val, BOOL localOrigin=FALSE, BOOL affectKids=TRUE, int pivMode=PIV_NONE, BOOL ignoreLocks=FALSE)=0

virtual void	Rotate (TimeValue t, const Matrix3 &tmAxis, const Quat &val, BOOL localOrigin=FALSE, BOOL affectKids=TRUE, int pivMode=PIV_NONE, BOOL ignoreLocks=FALSE)=0

virtual void	Scale (TimeValue t, const Matrix3 &tmAxis, const Point3 &val, BOOL localOrigin=FALSE, BOOL affectKids=TRUE, int pivMode=PIV_NONE, BOOL ignoreLocks=FALSE)=0

Invalidate the Node's Caches

virtual void	InvalidateTreeTM ()=0

virtual void	InvalidateTM ()=0

virtual void	InvalidateWS ()=0

Pipeline Evaluation
virtual const ObjectState &	EvalWorldState (TimeValue time, BOOL evalHidden=TRUE)=0

Parent-Child Hierarchy Manipulation

virtual INode *	GetParentNode ()=0

virtual void	AttachChild (INode *node, int keepTM=1)=0

virtual void	Detach (TimeValue t, int keepTM=1)=0

virtual int	NumberOfChildren ()=0

virtual INode *	GetChildNode (int i)=0

virtual int	IsRootNode ()=0

Deleting the Node

virtual void	Delete (TimeValue t, int keepChildPosition)

Display Attributes

virtual void	Hide (BOOL onOff)=0
	Controls the hidden state of the node in the scene. More...

virtual int	IsHidden (DWORD hflags=0, BOOL forRenderer=FALSE)
	Determines if the node is hidden in the scene. More...

virtual int	IsNodeHidden (BOOL forRenderer=FALSE)
	Returns nonzero if the node is hidden in any way. More...

virtual int	IsFrozen ()=0
	Determines if the node is frozen in any way in the scene. More...

virtual void	Freeze (BOOL onOff)=0
	Controls the frozen state of the node in the scene. More...

virtual void	SetShowFrozenWithMtl (BOOL onOff)=0

virtual int	ShowFrozenWithMtl ()=0

virtual void	XRayMtl (BOOL onOff)=0
	Set the X-Ray node property. More...

virtual int	HasXRayMtl ()=0
	Returns nonzero if the X-Ray Material display property is on for the node; otherwise zero. More...

virtual void	BoxMode (BOOL onOff)=0

virtual int	GetBoxMode ()=0

virtual void	AllEdges (BOOL onOff)=0

virtual int	GetAllEdges ()=0

virtual void	VertTicks (int onOff)=0

virtual int	GetVertTicks ()=0

virtual void	BackCull (BOOL onOff)=0

virtual int	GetBackCull ()=0

virtual int	GetTrajectoryON ()

virtual void	SetTrajectoryON (BOOL onOff)

virtual void	ShowBone (int boneVis)=0

virtual void	BoneAsLine (int onOff)=0

virtual BOOL	IsBoneShowing ()=0

virtual BOOL	IsBoneOnly ()

virtual DWORD	GetWireColor ()=0

virtual void	SetWireColor (DWORD newcol)=0

virtual int	Selected ()=0

virtual int	Dependent ()=0

Rendering Attributes
virtual void	SetCastShadows (BOOL onOff)=0

virtual int	CastShadows ()=0

virtual void	SetRcvShadows (BOOL onOff)=0

virtual int	RcvShadows ()=0

virtual void	SetMotBlur (int kind)=0

virtual int	MotBlur ()=0

virtual float	GetImageBlurMultiplier (TimeValue t)

virtual void	SetImageBlurMultiplier (TimeValue t, float m)

virtual void	SetImageBlurMultController (Control *cont)

virtual Control *	GetImageBlurMultController ()

virtual BOOL	GetMotBlurOnOff (TimeValue t)

virtual void	SetMotBlurOnOff (TimeValue t, BOOL m)

virtual Control *	GetMotBlurOnOffController ()

virtual void	SetMotBlurOnOffController (Control *cont)

virtual void	SetRenderable (BOOL onOff)=0

virtual int	Renderable ()=0

virtual void	SetApplyAtmospherics (BOOL onOff)=0

virtual int	ApplyAtmospherics ()=0

virtual void	SetPrimaryVisibility (bool onOff)=0

virtual bool	GetPrimaryVisibility () const =0

virtual void	SetSecondaryVisibility (bool onOff)=0

virtual bool	GetSecondaryVisibility () const =0

virtual void	SetGenerateCaustics (BOOL onOff)

virtual int	GenerateCaustics ()

virtual void	SetRcvCaustics (BOOL onOff)

virtual int	RcvCaustics ()

virtual void	SetGenerateGlobalIllum (BOOL onOff)

virtual int	GenerateGlobalIllum ()

virtual void	SetRcvGlobalIllum (BOOL onOff)

virtual int	RcvGlobalIllum ()

virtual void	SetRenderOccluded (BOOL onOff)=0

virtual BOOL	GetRenderOccluded ()=0

Vertex Color Attributes
virtual void	SetCVertMode (int onOff)

virtual int	GetCVertMode ()

virtual void	SetShadeCVerts (int onOff)

virtual int	GetShadeCVerts ()

virtual int	GetVertexColorType ()

virtual void	SetVertexColorType (int nvct)

virtual int	GetVertexColorMapChannel ()
	get the map channel to be displayed as vertex color. More...

virtual void	SetVertexColorMapChannel (int vcmc)
	set the map channel to be displayed as vertex color. More...

CoreExport void	CopyProperties (INode *from)

Target/Node Selection

virtual void	SetTargetNodePair (int onOff)

virtual int	GetTargetNodePair ()

Node Target Management

virtual int	IsTarget ()=0

virtual void	SetIsTarget (BOOL b)=0

virtual INode *	GetTarget ()=0

virtual INode *	GetLookatNode ()=0

virtual Matrix3	GetParentTM (TimeValue t)=0

virtual int	GetTargetTM (TimeValue t, Matrix3 &m)=0

Object Reference

virtual Object *	GetObjectRef ()=0

virtual void	SetObjectRef (Object *o)=0

virtual Object *	GetObjOrWSMRef ()=0

Controller Access

virtual Control *	GetTMController ()=0

virtual BOOL	SetTMController (Control *m3cont)=0

virtual Control *	GetVisController ()=0

virtual void	SetVisController (Control *cont)=0

Visibility Related Methods

virtual float	GetVisibility (TimeValue t, Interval *valid=NULL)=0

virtual float	GetVisibility (TimeValue t, View &view, Interval *valid=NULL)

virtual void	SetVisibility (TimeValue t, float vis)=0

virtual float	GetLocalVisibility (TimeValue t, Interval *valid=NULL)=0

virtual BOOL	GetInheritVisibility ()=0

virtual void	SetInheritVisibility (BOOL onOff)=0

Renderer Materials

virtual Mtl *	GetMtl ()=0

virtual void	SetMtl (Mtl *matl)=0

GraphicsWindow Materials

virtual Material *	Mtls ()=0

virtual int	NumMtls ()=0

Object-Offset Methods
virtual void	SetObjOffsetPos (Point3 p)=0

virtual Point3	GetObjOffsetPos ()=0

virtual void	SetObjOffsetRot (Quat q)=0

virtual Quat	GetObjOffsetRot ()=0

virtual void	SetObjOffsetScale (ScaleValue sv)=0

virtual ScaleValue	GetObjOffsetScale ()=0

Pivot Management Methods
virtual void	CenterPivot (TimeValue t, BOOL moveObject)=0

virtual void	AlignPivot (TimeValue t, BOOL moveObject)=0

virtual void	WorldAlignPivot (TimeValue t, BOOL moveObject)=0

virtual void	AlignToParent (TimeValue t)=0

virtual void	AlignToWorld (TimeValue t)=0

virtual void	ResetTransform (TimeValue t, BOOL scaleOnly)=0

virtual void	ResetPivot (TimeValue t)=0

Put Nodes into the Foreground Plane

virtual void	FlagForeground (TimeValue t, BOOL notify=TRUE)=0

Active Grid Object
virtual int	IsActiveGrid ()=0

Temporary Storage of Data with Nodes
virtual void	SetNodeLong (LONG_PTR l)=0

virtual LONG_PTR	GetNodeLong ()=0

Access to Render Data

virtual RenderData *	GetRenderData ()=0

virtual void	SetRenderData (RenderData *rd)=0

Access User Defined Property Text
virtual void	GetUserPropBuffer (MSTR &buf)=0

virtual void	SetUserPropBuffer (const MSTR &buf)=0

virtual BOOL	GetUserPropString (const MSTR &key, MSTR &string)=0

virtual BOOL	GetUserPropInt (const MSTR &key, int &val)=0

virtual BOOL	GetUserPropFloat (const MSTR &key, float &val)=0

virtual BOOL	GetUserPropBool (const MSTR &key, BOOL &b)=0

virtual void	SetUserPropString (const MSTR &key, const MSTR &string)=0

virtual void	SetUserPropInt (const MSTR &key, int val)=0

virtual void	SetUserPropFloat (const MSTR &key, float val)=0

virtual void	SetUserPropBool (const MSTR &key, BOOL b)=0

virtual BOOL	UserPropExists (const MSTR &key)=0

Geometry/Graphics (G) Buffer ID Access

virtual ULONG	GetGBufID ()=0

virtual void	SetGBufID (ULONG id)=0

virtual UWORD	GetRenderID ()

virtual void	SetRenderID (UWORD id)

Node Grouping

virtual BOOL	IsGroupMember ()=0

virtual BOOL	IsGroupHead ()=0

virtual BOOL	IsOpenGroupMember ()

virtual BOOL	IsOpenGroupHead ()

virtual void	SetGroupMember (BOOL b)

virtual void	SetGroupHead (BOOL b)

virtual void	SetGroupMemberOpen (BOOL b)

virtual void	SetGroupHeadOpen (BOOL b)

IK Related Methods

virtual float	GetPosTaskWeight ()

virtual float	GetRotTaskWeight ()

virtual void	SetPosTaskWeight (float w)

virtual void	SetRotTaskWeight (float w)

virtual BOOL	GetTaskAxisState (int which, int axis)

virtual void	SetTaskAxisState (int which, int axis, BOOL onOff)

virtual DWORD	GetTaskAxisStateBits ()

WSMDerivedObject Access
virtual void	CreateWSMDerivedObject ()

virtual IDerivedObject *	GetWSMDerivedObject ()

Scene XRef Access

virtual CoreExport MaxSDK::AssetManagement::AssetUser	GetXRefFile (int i)

virtual void	SetXRefFile (int i, const MaxSDK::AssetManagement::AssetUser &file, BOOL reload)

virtual int	GetXRefFileCount ()

virtual BOOL	AddNewXRefFile (const MaxSDK::AssetManagement::AssetUser &file, BOOL loadNow=TRUE, BOOL hideInManagerUI=FALSE)

virtual BOOL	DeleteXRefFile (int i)

virtual BOOL	BindXRefFile (int i)

virtual void	DeleteAllXRefs ()

virtual BOOL	ReloadXRef (int i)

virtual void	FlagXrefChanged (int i)

virtual BOOL	UpdateChangedXRefs (BOOL redraw=TRUE)

virtual INode *	GetXRefTree (int i)

virtual INode *	GetXRefParent (int i)

virtual void	SetXRefParent (int i, INode *par, BOOL autoOffset=TRUE)

virtual BOOL	FindUnresolvedXRefs (Tab< MSTR * > &fnames)

virtual void	AttemptToResolveUnresolvedXRefs ()

virtual DWORD	GetXRefFlags (int i)

virtual void	SetXRefFlags (int i, DWORD flag, BOOL onOff)

virtual bool	IsSceneXRefNode () const

Bone Methods

virtual void	SetBoneNodeOnOff (BOOL onOff, TimeValue t)

virtual void	SetBoneAutoAlign (BOOL onOff)

virtual void	SetBoneFreezeLen (BOOL onOff)

virtual void	SetBoneScaleType (int which)

virtual void	SetBoneAxis (int which)

virtual void	SetBoneAxisFlip (BOOL onOff)

virtual BOOL	GetBoneNodeOnOff ()

virtual BOOL	GetBoneNodeOnOff_T (TimeValue t)

virtual BOOL	GetBoneAutoAlign ()

virtual BOOL	GetBoneFreezeLen ()

virtual int	GetBoneScaleType ()

virtual int	GetBoneAxis ()

virtual BOOL	GetBoneAxisFlip ()

virtual void	RealignBoneToChild (TimeValue t)

virtual void	ResetBoneStretch (TimeValue t)

virtual Matrix3	GetStretchTM (TimeValue t, Interval *valid=NULL)

Node Was Loaded By The Last Merge
virtual bool	WasLoadedByLastMerge () const

Public Member Functions inherited from ReferenceTarget
virtual CoreExport void	GetClassName (MSTR &s)
	Retrieves the (localizable) name of the plugin class. More...

virtual CoreExport SClass_ID	SuperClassID ()
	Retrieves a constant representing the type of the plugin. More...

virtual BOOL	IsRefTarget ()
	Checks if this is a ReferenceTarget. More...

CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference. More...

CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references. More...

CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents. More...

void	BeginDependencyTest ()
	Starts Dependency Test. More...

BOOL	EndDependencyTest ()
	Ends Dependency Test. More...

virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target. More...

virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo. More...

virtual void	RefDeleted ()
	Called after a references to this is deleted. More...

virtual void	RefDeletedUndoRedo ()
	Called after a references to this is deleted because of undo or redo. More...

CoreExport RefResult	DeleteAllRefsToMe ()
	Deletes all references to this ReferenceTarget. More...

CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this. More...

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...

virtual CoreExport RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object. More...

virtual CoreExport void	BaseClone (ReferenceTarget from, ReferenceTarget to, RemapDir &remap)
	This method copies base class data from an object to its clone. More...

virtual CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=NULL, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS)
	Notify all dependent RefMakers concerned with the message. More...

void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline. More...

virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG. More...

virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets. More...

virtual CoreExport void *	GetInterface (ULONG id)
	Inherited from Animatable. More...

CoreExport	ReferenceTarget ()
	Constructor. More...

virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents. More...

CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents. More...

Public Member Functions inherited from ReferenceMaker
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers. More...

CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker. More...

CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item. More...

CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference. More...

virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered. More...

CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker. More...

virtual CoreExport IOResult	Save (ISave *isave)
	Called for saving data. More...

virtual CoreExport IOResult	Load (ILoad *iload)
	Called for loading data. More...

virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references. More...

virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy. More...

virtual CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags)
	Enumerate auxiliary files (e.g. bitmaps) More...

virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration. More...

virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save. More...

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...

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. More...

CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget. More...

virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker. More...

virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not. More...

virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save. More...

CoreExport	ReferenceMaker ()
	Constructor. More...

CoreExport void	DeleteMe ()
	Deletes an instance of this class. More...

virtual CoreExport int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold. More...

virtual CoreExport RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference. More...

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 More...

virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present More...

virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim. More...

virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers. More...

virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim. More...

virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers. More...

virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete. More...

virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used. More...

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. More...

CoreExport	Animatable ()
	Constructor. More...

virtual CoreExport void	DeleteThis ()
	Deletes an instance of this class. More...

MSTR	ClassName () const
	Returns the name of the plugin class. More...

virtual CoreExport Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class. More...

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. More...

CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property. More...

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. More...

CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable. More...

CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable. More...

CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable. More...

virtual int	NumSubs ()

virtual Animatable *	SubAnim (int i)

virtual CoreExport MSTR	SubAnimName (int i)

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. More...

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. More...

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. More...

virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed. More...

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. More...

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 More...

virtual CoreExport void	MouseCycleCompleted (TimeValue t)

virtual CoreExport void	MouseCycleStarted (TimeValue t)

virtual int	NumParamBlocks ()

virtual IParamBlock2 *	GetParamBlock (int i)

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 ()

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

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 MSTR	SvGetName (IGraphObjectManager gom, IGraphNode gNode, bool isBeingEdited)

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... More...

virtual CoreExport bool	SvIsSelected (IGraphObjectManager gom, IGraphNode gNode)
	Returns true if the object is selected in its schematic view. More...

virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport COLORREF	SvHighlightColor (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	SvHandleDoubleClick (IGraphObjectManager gom, IGraphNode gNode)

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

virtual CoreExport bool	SvCanSelect (IGraphObjectManager gom, IGraphNode gNode)

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"... More...

virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method... More...

virtual CoreExport bool	SvDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship. More...

virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view... More...

CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class. More...

CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container. More...

CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container. More...

void	SetAFlag (DWORD mask)

void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags. More...

bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags. More...

void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags. More...

void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags. More...

bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags. More...

CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit. More...

CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit. More...

CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit. More...

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()

virtual LifetimeType	LifetimeControl ()

virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

CoreExport	~FPMixinInterface ()

virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)

virtual Interface_ID	GetID ()

Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

virtual ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Static Public Attributes
static const ULONG	kNullHandle = 0
	This represents the value of an invalid node handle. More...

Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

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. More...

static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object. More...

static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle. More...

static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables. More...

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. More...

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. More...

static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index. More...

static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index. More...

static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Protected Member Functions inherited from ReferenceTarget
virtual CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep)
	Method to perform an enumeration on a ReferenceTarget. More...

virtual CoreExport	~ReferenceTarget ()=0
	Destructor. More...

Protected Member Functions inherited from ReferenceMaker
virtual RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)=0
	Receives and responds to messages. More...

virtual CoreExport	~ReferenceMaker ()=0
	Destructor. More...

virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`. More...

void	BlockEval ()

void	UnblockEval ()

int	Evaluating ()

CoreExport RefResult	StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)

Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor. More...

Protected Member Functions inherited from Noncopyable
	Noncopyable ()

	~Noncopyable ()

Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)

FPMixinInterface &	operator= (const FPMixinInterface &rhs)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Protected Attributes inherited from Animatable
DWORD	aflag

AnimPropertyList	aprops

Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Member Enumeration Documentation

anonymous enum

Enumerator
getPosTaskWeight
getRotTaskWeight
setPosTaskWeight
setRotTaskWeight
setBoneNodeOnOff
setBoneNodeOnOffM
setBoneAutoAlign
setBoneFreezeLen
setBoneScaleType
getBoneNodeOnOff
getBoneAutoAlign
getBoneFreezeLen
getBoneScaleType
realignBoneToChild
resetBoneStretch
getStretchTM
getBoneAxis
getBoneAxisFlip
setBoneAxis
setBoneAxisFlip
setPrimaryVisibility
getPrimaryVisibility
setSecondaryVisibility
getSecondaryVisibility
setApplyAtmospherics
getApplyAtmospherics
getVertexColorType
setVertexColorType
getCVertMode
setCVertMode
getShadeCVerts
setShadeCVerts
getNodeHandle
getVertexColorMapChannel
setVertexColorMapChannel
isSceneXRefNode
kLastFPFuncID

              {  getPosTaskWeight, getRotTaskWeight, setPosTaskWeight, setRotTaskWeight, 
                 // new bones
                 setBoneNodeOnOff, setBoneNodeOnOffM, setBoneAutoAlign, setBoneFreezeLen, setBoneScaleType, getBoneNodeOnOff, 
                 getBoneAutoAlign, getBoneFreezeLen, getBoneScaleType, realignBoneToChild, resetBoneStretch, getStretchTM,
                 getBoneAxis,      getBoneAxisFlip,  setBoneAxis,      setBoneAxisFlip,
                 // rendering flag access
                 setPrimaryVisibility, getPrimaryVisibility, setSecondaryVisibility, getSecondaryVisibility, setApplyAtmospherics, getApplyAtmospherics,
                 // vertex color access
                 getVertexColorType, setVertexColorType, getCVertMode, setCVertMode, getShadeCVerts, setShadeCVerts,
                 getNodeHandle,  
                 // get/set map channel to be displayed as vertex color.
                 getVertexColorMapChannel, setVertexColorMapChannel,
                 isSceneXRefNode,
                 // new Func IDs   >>>> >>>  MUST << <<<<  be inserted before kLastFPFuncID
                 // !!!!!   that means that this MUST be the last enum value  !!!!!
                 kLastFPFuncID
         };

anonymous enum

Enumerator
boneScaleTypeEnum
boneAxisEnum
vertexColorTypeEnum

              {  boneScaleTypeEnum, boneAxisEnum, 
                 vertexColorTypeEnum,
         };

Member Function Documentation

virtual void DisposeTemporary ( )

inlinevirtual

Remarks: If this was a temporary INode (like an INodeTransformed) then this method will delete it. Also see the method Interface::GetModContexts().

Reimplemented in INodeTransformed.

72 {}

virtual INode* GetActualINode ( )

inlinevirtual

Remarks: In the case of INodeTransformed, this method retrieves a pointer to the real node.

Example: EditPolyData *EditPolyMod::GetEditPolyDataForNode (INode *node) {

if (node == NULL) return (EditPolyData *) GetPrimaryLocalModData();

if (ip)

{

ModContextList list;

INodeTab nodes;

ip->GetModContexts(list,nodes);

for (int i=0; i<list.Count(); i++)

{

if (nodes[i]->GetActualINode() != node) continue;

EditPolyData *pData = (EditPolyData *) list[i]->localData;

return pData;

}

}

else // in case this modifier is not selected in the modify panel.

{

// search down the geom pipeline.

Object* pObj = node->GetObjectRef();

while(pObj)

{

if (pObj->SuperClassID() == GEN_DERIVOB_CLASS_ID)

{

IDerivedObject* pDObj = dynamic_cast<IDerivedObject*>(pObj);

int modCount = pDObj->NumModifiers();

for (int i = 0; i < modCount; ++i)

{

if (pDObj->GetModifier(i) == this)

{

ModContext* pContext = pDObj->GetModContext(i);

if (pContext)

{

return dynamic_cast<EditPolyData*>(pContext->localData);

}

}

}

pObj = pDObj->GetObjRef(); //try the next object

}

else if (pObj->GetInterface(IID_XREF_ITEM)) //skip all the XRefObj and check its source object.

{

IXRefItem* pXRefItem = static_cast<IXRefItem*>(pObj->GetInterface(IID_XREF_ITEM));

if (pXRefItem)

{

ReferenceTarget* pTarg = FindFirstNonXRefTarg(pXRefItem);

pObj = dynamic_cast<Object*>(pTarg);

}

else

{

pObj = nullptr;

}

}

else

{

pObj = nullptr;

}

}

}

return NULL;

}

Returns: A pointer to the node.

Reimplemented in INodeTransformed.

81 {return this;}

virtual const MCHAR* GetName ( )

pure virtual

Remarks: Returns the name of the node.

Implemented in INodeTransformed.

virtual void SetName ( const MCHAR * s )

pure virtual

Remarks: Sets the name of the node.

Parameters

s	The name of the node.

Implemented in INodeTransformed.

WStr BuildHierarchyName	(	bool	doQuoted = `true`,
		bool	isRootIncluded = `false`
	)

inline

Remarks: Builds a string representing the object's hierachy path.

Parameters

doQuoted	Place quotes around each level name.
isRootIncluded	Determines whether root node is to be included in path name.

         {
             const WStr nullStr = L"";
             const WStr sepStr = L"/";
             WStr pathname;
 
             WStr levelMarker = nullStr;
             if (doQuoted)
             {
                 levelMarker = L"'";
             }
 
             INode* nextNode = this;
             const WStr* separator = &nullStr;
             while (nextNode != NULL)
             {
                 INode* nodeCurr = nextNode;
                 nextNode = nodeCurr->GetParentNode();
                 if (isRootIncluded || (nextNode != NULL))
                 {
                     WStr levelName(nodeCurr->GetName());
                     pathname = levelMarker + levelName + levelMarker + (*separator) + pathname;
                 }
 
                 separator = &sepStr;
             }
 
             return pathname;
         }

virtual Matrix3 GetNodeTM	(	TimeValue	t,
		Interval *	valid = `NULL`
	)

pure virtual

Remarks: This method returns the world space transformation matrix of the node at the specified time. This matrix contains its parents transformation. This matrix does not include the object-offset transformation, or any world space modifier (Space Warp) affects. If you select a single node and change the reference coordinate system to 'Local', you'll see the node's axes tripod displayed. This tripod graphically depicts the nodes transformation matrix. The Node TM may be considered the world space transformation as far as kinematics is concerned. This is almost the complete world space transformation as far as the geometry of the object is concerned, except it does not include the object-offset transformation. See the method INode::GetObjectTM() for the complete world space transformation of the geometry of the object. The Node TM is inherited. When a node asks to retrieve its parents TM, it gets its parents Node TM. It does not get its parents Object TM. The object-offset transformation is not inherited.

Example: //Get the current position for the purpose of computing the next frame

//This function checks to see whether or not the node is a delegate, in which

//case the GetTM function is called.

static Matrix3 GetCurrentMatrix(INode *node, TimeValue t)

{

Object *o = node->GetObjectRef();

if (o->ClassID() == DELEG_CLASSID)

{

IDelegate *cd = (IDelegate *) o->GetInterface(I_DELEGINTERFACE);

if (cd->IsComputing())

return cd->GetTM(node,t);

}

return node->GetNodeTM(t);

}

Parameters

t	Specifies the time to retrieve the TM.
valid	Points to storage for the validity interval of the transformation matrix. The interval, if passed, is intersected with the validity interval of the NodeTM.

Returns: The node's world space transform matrix.

Implemented in INodeTransformed.

virtual void SetNodeTM	(	TimeValue	t,
		Matrix3 &	tm
	)

pure virtual

Remarks: This methods sets the node's world space transformation matrix (without the object-offset transformation or world space modifier affect). This method will perform the appropriate operation to the node's transform controller. For example, if the node has a parent, this method will take the parent's transformation into consideration when it calls SetValue() on the controller. This method can be used to set the world space position of the node.

Example: void MyArcDlgCB::Drag(Quat q, BOOL buttonUp) {

Matrix3 tm;

MakeMatrix(qstart*q, tm);

node->SetNodeTM(ip->GetTime(), tm);

ip->RedrawViews(ip->GetTime());

}

Parameters

t	Specifies the time to set the transformation matrix.
tm	The node's world space transformation matrix.

Implemented in INodeTransformed.

virtual void InvalidateTreeTM ( )

pure virtual

Remarks: This method will notify the node's subtree that the transformation matrix has changed. NotifyDependents() is called with the message REFMSG_CHANGE.

Implemented in INodeTransformed.

virtual void InvalidateTM ( )

pure virtual

Remarks: This method will invalidate the node's transformation matrix cache.

Implemented in INodeTransformed.

virtual void InvalidateWS ( )

pure virtual

Remarks: This method will invalidate the node's world space cache.

Implemented in INodeTransformed.

virtual void InvalidateRect	(	TimeValue	t,
		bool	oldRect = `false`
	)

pure virtual

Remarks: This method invalidates the rectangle in the viewports that the node occupies. Rectangles flagged as invalid will be updated on the next screen redraw. Each node caches the rectangle in the viewports that the node occupies. These caches are updated when the node is drawn in the viewports.

Example: DisplayState BendManip::MouseEntersObject(TimeValue t, ViewExp* /*pVpt*/, IPoint2& m, ManipHitData* pHitData)

{

mousePos = m;

mouseWithin = TRUE;

node->InvalidateRect(t);

return kFullRedrawNeeded;

}

Parameters

t - The time to invalidate the node's rectangle

oldRect - If true, the cached viewport rectangles of the node are invalidated. This would be the case when a node property that doesn't affect the size or position of the node's viewport rectangles, such as wireframe color, is changed. Otherwise, the node's current rectangle in each viewport is invalidated. If the node's world space cache is not valid, the node's world state at time t will be evaluated, from which its current viewport rectangles are calculated.

Implemented in INodeTransformed.

virtual Matrix3 GetObjectTM	(	TimeValue	time,
		Interval *	valid = `NULL`
	)

pure virtual

Remarks: This method returns the transformation matrix the object needs to be multiplied by to transform it into world space. At times, this matrix may be the identity. For example, a deformable object that has a Space Warp applied to it would already have been translated into world space by the space warp. Since the object is already in world space the matrix needed to get it there is the identity. This matrix would not be the identity for a deformable object with only object space modifiers applied. This object would indeed need to be transformed. In this case the TM returned would include the NodeTM plus the object-offset transformation. So, GetObjectTM() is dependent on the context when it is called – it will either be equal to GetObjTMAfterWSM() or GetObjTMBeforeWSM(). Developers should use GetObjTMBeforeWSM() if what is wanted is the object TM and not the identity matrix. For non-deformable objects this matrix may include the NodeTM, the object-offset transformation and the world space modifier affect. This matrix could be used, for example, if you have a TriObject and wanted to get the world space coordinate of one of its vertices. You could do this by taking the vertex coordinate in object space and multiplying it by the matrix returned from this method. This matrix is also often used inside an object's Display() and HitTest() methods. When an object goes to draw itself (in its BaseObject::Display() method) it is given a node pointer. What the object normally does is use the node pointer and calls GetObjectTM(). It then takes the matrix returned and sets it into the graphics window (using GraphicsWindow::setTransform()). In this way, when the object starts drawing points in object space, they will be transformed with this matrix. This will transform the points into world space when they are drawn. The Object TM is not inherited.

Parameters

time	Specifies the time to retrieve the object's transform matrix.
valid	Points to storage for the validity interval of the transformation matrix.

Returns: The object's transformation matrix.

Implemented in INodeTransformed.

virtual Matrix3 GetObjTMBeforeWSM	(	TimeValue	time,
		Interval *	valid = `NULL`
	)

pure virtual

Remarks: This method explicitly retrieves the pipeline ObjectState TM before any world space modifiers have been applied. This includes the node's TM and the object-offset transformation (but not any world space modifier affect). See the section on the Geometry Pipeline System for additional details on this method.

Parameters

time	Specifies the time to retrieve the transform matrix.
valid	Points to storage for the validity interval of the transformation matrix.

Implemented in INodeTransformed.

virtual Matrix3 GetObjTMAfterWSM	(	TimeValue	time,
		Interval *	valid = `NULL`
	)

pure virtual

Remarks: This method explicitly retrieves the pipeline ObjectState TM after any world space modifiers have been applied. This includes the Node TM, the object-offset transformation, and any world space modifier affects. In some cases a world space modifier can actually deform the TM itself if it cannot deform the object. Examples of this are cameras and lights. These objects do not have any 'object' to deform, so the space warp deforms the TM instead. See the section on the Geometry Pipeline System for additional details on this method. Note: Beware of calling this method from inside a function that performs a mesh traversal as doing so can invalidate the mesh.

Parameters

time	Specifies the time to retrieve the object's transform matrix.
valid	Points to storage for the validity interval of the transformation matrix.

Implemented in INodeTransformed.

virtual const ObjectState& EvalWorldState	(	TimeValue	time,
		BOOL	evalHidden = `TRUE`
	)

pure virtual

Remarks: This method should be called when a developer needs to work with an object that is the result of the node's pipeline. This is the object that the appears in the scene.

This may not be an object that anyone has a reference to - it may just be an object that has flowed down the pipeline. For example, if there is a Sphere in the scene that has a Bend and Taper applied, EvalWorldState() would return an ObjectState containing a TriObject. This is the result of the sphere turning into a TriObject and being bent and tapered (just as it appeared in the scene).

If a developer needs to access the object that the node in the scene references, then the method INode::GetObjectRef() should be used instead.

Parameters

time	Specifies the time to retrieve the object state.
evalHidden	If FALSE and the node is hidden, the pipeline will not actually be evaluated (however the TM will).

Returns: The ObjectState that is the result of the pipeline. See Class ObjectState.
// Get the object from the node

ObjectState os = node->EvalWorldState(ip->GetTime());

if (os.obj->SuperClassID()==GEOMOBJECT_CLASS_ID)

{

obj = (GeomObject*)os.obj;

//...

}

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(ip->GetTime()).obj;

if (obj->CanConvertToType(Class_ID(TRIOBJ_CLASS_ID, 0)))

{

TriObject *tri = (TriObject *) obj->ConvertToType(ip->GetTime(),

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;

}

}

Implemented in INodeTransformed.

virtual INode* GetParentNode ( )

pure virtual

Remarks: Retrieves the parent node of this node. If the node is not linked, its parent is the root node. This may be checked using INode::IsRootNode().

Example: static BOOL IsAncestorSelected(INode *node)

{

if (node->GetParentNode()) {

if (node->GetParentNode()->Selected()) return TRUE;

return IsAncestorSelected(node->GetParentNode());

} else {

return FALSE;

}

}

Implemented in INodeTransformed.

virtual void AttachChild	(	INode *	node,
		int	keepTM = `1`
	)

pure virtual

Remarks: Makes the specified node a child of this node.

Parameters

node	Specifies the node to attach.
keepTM	If nonzero, the world transform matrix of the specified (child) node is unchanged after the attach operation, i.e. INode::GetNodeTM returns the same matrix both before and after the attach operation. Otherwise, the world transform of the specified (child) node is affected by the parent node's transform.

Implemented in INodeTransformed.

virtual void Detach	(	TimeValue	t,
		int	keepTM = `1`
	)

pure virtual

Remarks: Detaches this node from its parent.

Parameters

t	Specifies the time at which to detach the node.
keepTM	If nonzero, the world transform matrix of the detached node is unchanged, i.e. INode::GetNodeTM returns the same matrix both before and after the detach operation. Otherwise, the world transform of the detached node may change as a result of the detach operation since the node stops inheriting its parent node's transform.

Note: The node is detached from its current parent and attached to the scene's root node.

Implemented in INodeTransformed.

virtual int NumberOfChildren ( )

pure virtual

Remarks: Returns the number of children of this node.

Implemented in INodeTransformed.

virtual INode* GetChildNode ( int i )

pure virtual

Remarks: Retrieves the 'i-th' child node of this node.

Parameters

i	Specifies the child node to retrieve.

Implemented in INodeTransformed.

virtual void Delete	(	TimeValue	t,
		int	keepChildPosition
	)

inlinevirtual

Remarks: This method will delete the node, handle removing it from the hierarchy, and handle undo.

Parameters

t	The time for the deletion.
keepChildPosition	If TRUE the position of any children of this node are kept the same; otherwise linked children may move due to the deletion.

Reimplemented in INodeTransformed.

390 {}

virtual void Hide ( BOOL onOff )

pure virtual

Controls the hidden state of the node in the scene.

Parameters

onOff Pass TRUE to hide the node in the scene; pass FALSE to make the node visible.

Implemented in INodeTransformed.

virtual int IsHidden	(	DWORD	hflags = `0`,
		BOOL	forRenderer = `FALSE`
	)

inlinevirtual

Determines if the node is hidden in the scene.

Parameters

hflags If you pass 0, you will get the hidden state of the node. If you pass one or more of the flags shown below, the method checks the Class_ID of the node to see if it's hidden by the specified category. You may specify one or more of the following values:

HIDE_OBJECTS
HIDE_SHAPES
HIDE_LIGHTS
HIDE_CAMERAS
HIDE_HELPERS
HIDE_WSMS
HIDE_SYSTEMS
HIDE_PARTICLES
HIDE_ALL
HIDE_NONE

See the method Interface::GetHideByCategoryFlags() for how to retrieve the currently set values to use as the flags for this method.

forRenderer If true, test to see if the node is hidden for the render, else if it is hidden in the viewport

Returns: Nonzero if the node is hidden; otherwise 0.

Reimplemented in INodeTransformed.

419 {return 0;}

virtual int IsNodeHidden ( BOOL forRenderer = FALSE )

inlinevirtual

Returns nonzero if the node is hidden in any way.

This method takes into account both the node hidden attribute and the 'Hide By Category' flags.

Parameters

forRenderer If true, test to see if the node is hidden for the render, else if it is hidden in the viewport returns zero.

Reimplemented in INodeTransformed.

425 {return 0;}

virtual int IsFrozen ( )

pure virtual

Determines if the node is frozen in any way in the scene.

A node can have the frozen property set, or be frozen by 'ghosting'

Returns: Nonzero if the node is frozen; otherwise 0.

Implemented in INodeTransformed.

virtual void Freeze ( BOOL onOff )

pure virtual

Controls the frozen state of the node in the scene.

A frozen node is visible but cannot be picked.

Parameters

onOff TRUE if the node should be frozen; FALSE if the node should not be frozen.

Implemented in INodeTransformed.

virtual void SetShowFrozenWithMtl ( BOOL onOff )

pure virtual

Remarks: This method allows you to set the NODE_SHOW_FRZN_WITH_MTL flag in the node so that the node will be displayed in a frozen state with materials applied.

Parameters

onOff TRUE to set the flag; FALSE to disable.

Implemented in INodeTransformed.

virtual int ShowFrozenWithMtl ( )

pure virtual

Remarks: This method returns the state of the NODE_SHOW_FRZN_WITH_MTL flag in the node and whether it is enabled or disabled.

Implemented in INodeTransformed.

virtual void XRayMtl ( BOOL onOff )

pure virtual

Set the X-Ray node property.

The X-Ray Material display property allows you to quickly make objects transparent. This method toggles it on or off for this node.

Parameters

onOff TRUE to use; FALSE to not use.

Implemented in INodeTransformed.

virtual int HasXRayMtl ( )

pure virtual

Returns nonzero if the X-Ray Material display property is on for the node; otherwise zero.

Implemented in INodeTransformed.

virtual void BoxMode ( BOOL onOff )

pure virtual

Remarks: Controls if the node is displayed with a bounding box representation in the scene.

Parameters

onOff TRUE to display the node as its bounding box; FALSE for normal display.

Implemented in INodeTransformed.

virtual int GetBoxMode ( )

pure virtual

Remarks: Determines if the node is displayed in box mode in the scene.

Returns: Nonzero if the node is displayed in box mode; otherwise 0.

Implemented in INodeTransformed.

virtual void AllEdges ( BOOL onOff )

pure virtual

Remarks: Controls the display of all the edges of the node (including "hidden" ones).

Parameters

onOff TRUE to display all the node's edges; FALSE to not display "hidden" edges.

Implemented in INodeTransformed.

virtual int GetAllEdges ( )

pure virtual

Remarks: Determines if all the edges of the node are displayed.

Returns: Nonzero if all the edges (including "hidden" ones) are displayed; otherwise 0.

Implemented in INodeTransformed.

virtual void VertTicks ( int onOff )

pure virtual

Remarks: This method allows you to enable or disable the display of vertex ticks on the node.

Parameters

onOff TRUE to enable; FALSE to disable.

Implemented in INodeTransformed.

virtual int GetVertTicks ( )

pure virtual

Remarks: This method returns the state of the vertex ticks display. TRUE if enabled; FALSE if disabled.

Implemented in INodeTransformed.

virtual void BackCull ( BOOL onOff )

pure virtual

Remarks: Controls if the node is displayed using back-face culling (faces whose surface normals are pointing away from the observer are not drawn).

Parameters

onOff TRUE if the node should be drawn using back-face culling; FALSE if all faces should be drawn.

Implemented in INodeTransformed.

virtual int GetBackCull ( )

pure virtual

Remarks: Determines if back-face culling is being used to draw the node.

Returns: Nonzero if back-face culling is used; otherwise 0.

Implemented in INodeTransformed.

virtual void UnhideObjectAndLayer ( bool dolayer = true )

inlinevirtual

Makes the node, and optionally the layer, visible in the scene.

Parameters

dolayer Pass TRUE to unhide the node in the scene; pass FALSE to make the node visible.

494 {Hide(FALSE);}

INode::Hide

virtual void Hide(BOOL onOff)=0

Controls the hidden state of the node in the scene.

virtual int IsObjectHidden ( )

inlinevirtual

Returns the hidden state of this node in the scene.

Returns: non-zero if this node is hidden, else false

498 {return 0;}

virtual void UnfreezeObjectAndLayer ( bool dolayer = true )

inlinevirtual

Unfreeze the node, and optionally its layer.

Parameters

dolayer if true, unfreeze the layer

502 {Freeze(FALSE);}

INode::Freeze

virtual void Freeze(BOOL onOff)=0

Controls the frozen state of the node in the scene.

virtual int IsObjectFrozen ( )

inlinevirtual

Test the frozen property of this node.

Returns: non-zero if this node is frozen, else zero

506 {return 0;};

virtual int HasObjectXRayMtl ( )

inlinevirtual

Get the X-Ray node property.

The X-Ray Material display property allows you to quickly make objects transparent.

Returns: TRUE if X-Ray materials are enabled; else FALSE

512 {return 0;};

virtual void IgnoreExtents ( BOOL onOff )

pure virtual

Ignore this node during zoom extents.

Parameters

onOff If true, Set this node to be ignored during zoom extents.

Implemented in INodeTransformed.

virtual int GetIgnoreExtents ( )

pure virtual

Is this node ignored during zoom extents.

Returns: true if this node is to be ignored during zoom extents.

Implemented in INodeTransformed.

virtual void SetCastShadows ( BOOL onOff )

pure virtual

Remarks: Sets the shadow casting attribute of the node to on or off.

Parameters

onOff TRUE to turn shadow casting on; FALSE to turn it off.

Implemented in INodeTransformed.

virtual int CastShadows ( )

pure virtual

Remarks: Retrieves the shadow casting attribute of the node.

Returns: Nonzero indicates the node casts shadows; zero if the node does not cast shadows.

Implemented in INodeTransformed.

virtual void SetRcvShadows ( BOOL onOff )

pure virtual

Remarks: Sets the shadow receiving attribute of the node to on or off.

Parameters

onOff TRUE to turn shadow receiving on; FALSE to turn it off.

Implemented in INodeTransformed.

virtual int RcvShadows ( )

pure virtual

Remarks: Retrieves the shadow receiving attribute of the node.

Returns: Nonzero indicates the node receives shadows; zero if the node does not receive shadows.

Implemented in INodeTransformed.

virtual void SetMotBlur ( int kind )

pure virtual

Remarks: Sets the type of motion blur used by the node.

Parameters

kind	The kind of motion blur. One of the following values: 0: None. 1: Object Motion Blur. 2: Image Motion Blur.

virtual int MotBlur ( )

pure virtual

Remarks: Retrieves the type of motion blur used by the node.

Returns: One of the following values:

0: None
1: Object Motion Blur.
2: Image Motion Blur.

Implemented in INodeTransformed.

virtual float GetImageBlurMultiplier ( TimeValue t )

inlinevirtual

Remarks: Returns the image motion blur multiplier value at the specified time.

Parameters

t	The time to retrieve the value.

Reimplemented in INodeTransformed.

556 { return 1.0f;}

virtual void SetImageBlurMultiplier	(	TimeValue	t,
		float	m
	)

inlinevirtual

Remarks: Sets the image blur multiplier value for the node. This is used to increase or decrease the length of the blur 'streak'.

Parameters

t	The time to set the value.
m	The value to set.

Reimplemented in INodeTransformed.

562 {};

virtual void SetImageBlurMultController ( Control * cont )

inlinevirtual

Remarks: Sets the controller used for the image blur multiplier value.

Parameters

cont	Points for the controller to use.

Reimplemented in INodeTransformed.

566 {}

virtual Control* GetImageBlurMultController ( )

inlinevirtual

Remarks: Returns a pointer to the controller for the image blur multiplier value.

Reimplemented in INodeTransformed.

569 {return NULL; }

NULL

#define NULL

Definition: autoptr.h:18

virtual BOOL GetMotBlurOnOff ( TimeValue t )

inlinevirtual

Remarks: Returns TRUE if the object motion blur controller is 'on' at the specified time; otherwise FALSE.

Parameters

t	The time to check.

Default Implementation:: { return 1; }

Reimplemented in INodeTransformed.

577 { return 1; }

virtual void SetMotBlurOnOff	(	TimeValue	t,
		BOOL	m
	)

inlinevirtual

Remarks: Sets the state of the object motion blur controller to on or off at the specified time.

Parameters

t	The time to set the value.
m	TRUE for on; FALSE for off.

Default Implementation:: {}

Reimplemented in INodeTransformed.

584 { }

virtual Control* GetMotBlurOnOffController ( )

inlinevirtual

Remarks: Returns a pointer to the controller handling the object motion blur on / off setting.

Default Implementation:: { return NULL;}

Reimplemented in INodeTransformed.

589 { return NULL;}

NULL

#define NULL

Definition: autoptr.h:18

virtual void SetMotBlurOnOffController ( Control * cont )

inlinevirtual

Remarks: Sets the controller used for handling the object motion blur on / off setting.

Parameters

cont	Points to the controller to set.

Default Implementation:: {}

Reimplemented in INodeTransformed.

595 { }

virtual void SetRenderable ( BOOL onOff )

pure virtual

Remarks: Sets the state of the node's renderable flag. If this flag is on the node will appear in rendered images; if off it won't.

Parameters

onOff TRUE for on; FALSE for off.

Implemented in INodeTransformed.

virtual int Renderable ( )

pure virtual

Remarks: Returns non-zero if the renderable flag is on; zero if off.

Implemented in INodeTransformed.

virtual void SetApplyAtmospherics ( BOOL onOff )

pure virtual

Remarks: This method allows you to set the "apply atmospherics" flag for the node.

Parameters

onOff TRUE to enable the flag, FALSE to disable.

Implemented in INodeTransformed.

virtual int ApplyAtmospherics ( )

pure virtual

Remarks: This method returns the on/off state of the "apply atmospherics" flag.

Implemented in INodeTransformed.

virtual void SetPrimaryVisibility ( bool onOff )

pure virtual

Remarks: This method allows you to set the primary visibility flag and define whether or not the node is visible to the camera.

Parameters

onOff TRUE to enable the flag, FALSE to disable.

Implemented in INodeTransformed.

virtual bool GetPrimaryVisibility ( ) const

pure virtual

Remarks: This method returns the on/off state of the primary visibility to determine whether or not the node is visible to the camera.

Implemented in INodeTransformed.

virtual void SetSecondaryVisibility ( bool onOff )

pure virtual

Remarks: This method allows you to set the secondary visibility flag and define whether or not the node is visible to reflections and refractions..

Parameters

onOff TRUE to enable the flag, FALSE to disable.

Implemented in INodeTransformed.

virtual bool GetSecondaryVisibility ( ) const

pure virtual

Remarks: This method returns the on/off state of the secondary visibility to determine whether or not the node is visible to reflections and refractions.

Implemented in INodeTransformed.

virtual void SetGenerateCaustics ( BOOL onOff )

inlinevirtual

Reimplemented in INodeTransformed.

631 {}

virtual int GenerateCaustics ( )

inlinevirtual

Reimplemented in INodeTransformed.

632 {return 0;}

virtual void SetRcvCaustics ( BOOL onOff )

inlinevirtual

Reimplemented in INodeTransformed.

633 {}

virtual int RcvCaustics ( )

inlinevirtual

Reimplemented in INodeTransformed.

634 {return 0;}

virtual void SetGenerateGlobalIllum ( BOOL onOff )

inlinevirtual

Reimplemented in INodeTransformed.

636 {}

virtual int GenerateGlobalIllum ( )

inlinevirtual

Reimplemented in INodeTransformed.

637 {return 0;}

virtual void SetRcvGlobalIllum ( BOOL onOff )

inlinevirtual

Reimplemented in INodeTransformed.

638 {}

virtual int RcvGlobalIllum ( )

inlinevirtual

Reimplemented in INodeTransformed.

639 {return 0;}

virtual void SetCVertMode ( int onOff )

inlinevirtual

Remarks: Sets the vertex color flag to on or off. This controls the display of assigned vertex colors. Vertex colors are assigned in the editable mesh in vertex or face sub-object level. Vertex colors only appear in viewports using Smooth or Smooth + Highlight display modes, regardless of the state of this flag.

Parameters

onOff Non-zero for on; zero for off.

650 {}

virtual int GetCVertMode ( )

inlinevirtual

Remarks: Returns non-zero if the vertex color flag if on; otherwise zero.

653 {return 0;}

virtual void SetShadeCVerts ( int onOff )

inlinevirtual

Remarks: Sets the vertex color shaded flag. This determines whether the vertex colors appears shaded in the viewport. When this is off, the colors are unshaded, and appear in their pure RGB values, looking a little like self-illuminated materials. When on, the colors appear like any other assigned color in the viewports

Parameters

onOff Non-zero of on; zero of off.

661 {}

virtual int GetShadeCVerts ( )

inlinevirtual

Remarks: Returns non-zero if the vertex color shaded flag is on; zero if off.

664 {return 0;}

virtual int GetVertexColorType ( )

inlinevirtual

Remarks: Get the node's vertex color "type". This is one of the nodeVertexColorType enums above.

668 { return 0; }

virtual void SetVertexColorType ( int nvct )

inlinevirtual

Remarks: Set the node's vertex color "type". This is one of the nodeVertexColorType enums above.

672 { }

virtual int GetVertexColorMapChannel ( )

inlinevirtual

get the map channel to be displayed as vertex color.

675 { return 1; }

virtual void SetVertexColorMapChannel ( int vcmc )

inlinevirtual

set the map channel to be displayed as vertex color.

677 { }

virtual int GetTrajectoryON ( )

inlinevirtual

Remarks: Returns non-zero if the trajectory display is on; zero if the trajectory display is off.

683 {return 0;}

virtual void SetTrajectoryON ( BOOL onOff )

inlinevirtual

Remarks: This method toggles the trajectory display for the node.

Parameters

onOff TRUE for on; FALSE for off.

687 {}

virtual void ShowBone ( int boneVis )

pure virtual

Remarks: Controls the display of Bones in the scene. A bone is just the link (or line) connecting the node to its parent. These are the same options as available in the 3ds Max user interface in the Display branch, under Link Display, i.e. Display Links and Link Replaces Object.

Parameters

boneVis Specifies the display state:

0: Bones are not drawn.
1: Bones are drawn.
2: Only bones are shown.

Implemented in INodeTransformed.

virtual void BoneAsLine ( int onOff )

pure virtual

Remarks: Controls the display of Bones as simple lines in the scene.

Parameters

onOff Non-zero if bones should be shown as lines only; 0 for normal display.

Implemented in INodeTransformed.

virtual BOOL IsBoneShowing ( )

pure virtual

Remarks: Returns TRUE if the node's bone is turned on; otherwise FALSE.

Implemented in INodeTransformed.

virtual BOOL IsBoneOnly ( )

inlinevirtual

Remarks: Returns TRUE if the bone is showing but the object is hidden; FALSE if both the bone and the node is hidden.

Reimplemented in INodeTransformed.

710 { return 0; }

virtual void SetTargetNodePair ( int onOff )

inlinevirtual

Remarks: This method is used for hit-testing and selecting node and target as a single unit. In 3ds Max 2.0 and later you can click on the line connecting, say, a camera to its target and drag that around in the viewports. Doing so moves both the camera and its target as a locked pair. To accomplish this, the camera, light, and tape measure objects (those with two nodes linked by a Look At controller) check for a hit on the object-target line. If they get there (but not at the object or target itself), then they call this method passing TRUE. Then, when a hit is registered, 3ds Max checks the value of this variable (by calling GetTargetNodePair()), and, if it is TRUE, selects both the target and the node. If it's FALSE, then either the target or the node, but not both, gets selected, as with 3ds Max 1.x. For sample code see /MAXSDK/SAMPLES/OBJECTS/LIGHT.CPP or TAPEHELP.CPP.

Example: virtual void HitTest(MaxSDK::Graphics::HitTestContext& hittestContext, MaxSDK::Graphics::DrawContext& drawContext)

{

ViewExp* vpt = const_cast<ViewExp*>(drawContext.GetViewExp());

if (vpt->GetViewCamera() == drawContext.GetCurrentNode())

{

return;

}

drawContext.GetCurrentNode()->SetTargetNodePair(0);

__super::Display(drawContext);

}

Parameters

onOff TRUE for on; FALSE for off.

Default Implementation:: {}

735 {}

virtual int GetTargetNodePair ( )

inlinevirtual

Remarks: Returns the target/node pair setting stored by 3ds Max. See SetTargetNodePair() above for details.

Default Implementation:: { return 0; }

741 { return 0; }

virtual DWORD GetWireColor ( )

pure virtual

Remarks: Retrieves the node's wire-frame color. See COLORREF-DWORD format.

Implemented in INodeTransformed.

virtual void SetWireColor ( DWORD newcol )

pure virtual

Remarks: Sets the node's wire-frame color. This can be any of the 16 million possible colors in 24 bit. See COLORREF-DWORD format.

Parameters

newcol Specifies the new wire-frame color for the node. It may be specified using the RGB macro, for example: RGB(0,0,255);

Implemented in INodeTransformed.

virtual int Selected ( )

pure virtual

Remarks: Determines if the node is selected.

Returns: Non-zero if the node is selected; otherwise 0.

Implemented in INodeTransformed.

virtual int Dependent ( )

pure virtual

Remarks: Returns non-zero if the node has its dependent flag set; otherwise 0. This is dependent in the sense of 3ds Max's Views/Show Dependencies mode. When in the Modify branch, Show Dependencies will show all the nodes that are dependent on the current modifier or object being editing by highlighting them in green. It also set a flag in the node. This method allows a developer to check this flag.

Implemented in INodeTransformed.

virtual int IsRootNode ( )

pure virtual

Remarks: Determines if this node is the root node (does not have a parent node).

Example: bool UnflaggedNodeDeleter::Proc(INode * pNode)

{

// NOTE: should be called with Enumerate(procfirst = false) !

// Delete flagged node unless it is the root.

if (!pNode->IsRootNode() && !pNode->TestAFlag(A_WORK1)) {

pNode->Delete(0,TRUE);

}

return true;

}

Returns: Non-zero if the node is the root node; otherwise 0.

Implemented in INodeTransformed.

virtual BOOL GetTransformLock	(	int	type,
		int	axis
	)

pure virtual

Remarks: Retrieves the specified transform lock state of the node. When the user is doing interactive Moving / Rotating / Scaling these locks simply remove one of the components.

Parameters

type	See transformLockTypes.
axis	See Transform Lock Axis.

Returns: TRUE if the lock is set; otherwise FALSE.

Implemented in INodeTransformed.

virtual void SetTransformLock	(	int	type,
		int	axis,
		BOOL	onOff
	)

pure virtual

Remarks: Sets the specified transform lock state of the node. When the user is doing interactive Moving / Rotating / Scaling these locks simply remove one of the components.

Parameters

type	See Transform Lock Types.
axis	See Transform Lock Axis.
onOff	TRUE sets the lock on; FALSE sets the lock off.

Implemented in INodeTransformed.

virtual int IsTarget ( )

pure virtual

Remarks: Determines if the node is a target node of a lookat controller.

Returns: Non-zero if the node is a target; otherwise 0.

Implemented in INodeTransformed.

virtual void SetIsTarget ( BOOL b )

pure virtual

Remarks: This method controls the property of the node indicating if it's a target or not. Calling this is necessary when hooking up targets as the target node must have its IsTarget() property set.

Parameters

b	TRUE for set; FALSE for off.

Implemented in INodeTransformed.

virtual INode* GetTarget ( )

pure virtual

Remarks: Retrieves this node's target node if any.

Returns: NULL if this node has no target.

Implemented in INodeTransformed.

virtual INode* GetLookatNode ( )

pure virtual

Remarks: If this node is a target of a lookat controller, this method finds the node that looks at it.

Returns: The node that looks at this node or NULL if the node is not a target.

Implemented in INodeTransformed.

virtual Matrix3 GetParentTM ( TimeValue t )

pure virtual

Remarks: Retrieves the parent node's transformation matrix. This is simply for convenience. It is the equivalent to the following code: node->GetParentNode()->GetNodeTM();

Parameters

t	Specifies the time to retrieve the transformation matrix.

Returns: The parent node's transformation matrix.

Implemented in INodeTransformed.

virtual int GetTargetTM	(	TimeValue	t,
		Matrix3 &	m
	)

pure virtual

Remarks: Retrieves the target node's transformation matrix. This is simply for convenience. It is the equivalent to the following code:

node->GetTarget()->GetNodeTM();

Parameters

t	Specifies the time to retrieve the transformation matrix.
m	The result is stored here.

Returns: Nonzero if the target matrix was retrieved (the node had a target); otherwise 0.

Implemented in INodeTransformed.

virtual Object* GetObjectRef ( )

pure virtual

Remarks: Returns the object that this node references unless the node has been bound to a Space Warp. In that case this method will not return the WSM derived object even though the node's object reference points at it. Instead it will return the item that the WSM derived object references. Thus, this method will always return essentially the object space portion of the pipeline. In contrast, see GetObjOrWSMRef() below. See the Geometry Pipeline System section for additional details.

Implemented in INodeTransformed.

virtual void SetObjectRef ( Object * o )

pure virtual

Remarks: Sets the object that this node references. See the Geometry Pipeline System section for additional details.

Parameters

o	The object this node will reference.

Implemented in INodeTransformed.

virtual Object* GetObjOrWSMRef ( )

pure virtual

Remarks: This method returns the actual object reference of the node directly. So if this node is bound to a Space Warp this method will return a WSM derived object. If you want the object space portion of the pipeline see GetObjectRef() above.

Implemented in INodeTransformed.

virtual Control* GetTMController ( )

pure virtual

Remarks: Retrieves the node's transform controller. The standard 3ds Max transform controllers each have sub-controllers for position, rotation and scale. To access the data of the node's transform controller you may use Class IKeyControl. The following code fragment shows an example of how this may be done for a PRS controller.
Control *c;

c = node->GetTMController()->GetPositionController();

IKeyControl *ikeys = GetKeyControlInterface(c);

With this controller interface you can use its methods to get information about the keys. For example:
int num = ikeys->GetNumKeys();

Example: // Pre-multiply in position, rotation, scale order

TimeValue t = ip->GetTime();

pos = node->GetTMController()->GetPositionController();

pos->GetValue(t, &tmat, valid, CTRL_RELATIVE);

rot = node->GetTMController()->GetRotationController();

rot->GetValue(t, &tmat, valid, CTRL_RELATIVE);

scl = node->GetTMController()->GetScaleController();

scl->GetValue(t, &tmat, valid, CTRL_RELATIVE);

Implemented in INodeTransformed.

virtual BOOL SetTMController ( Control * m3cont )

pure virtual

Remarks: Sets the node's transform controller.

Parameters

m3cont The Matrix3 transform controller to use. This controller must return a SuperClassID of CTRL_MATRIX3_CLASS_ID

Returns: TRUE if the controller was a valid transform controller for this node, and the reference was successfully created, else FALSE.

Implemented in INodeTransformed.

virtual Control* GetVisController ( )

pure virtual

Remarks: Returns the visibility controller for this node.

Implemented in INodeTransformed.

virtual void SetVisController ( Control * cont )

pure virtual

Remarks: Sets the visibility controller for this node.

Parameters

cont	The controller to use for visibility control.

Implemented in INodeTransformed.

virtual float GetVisibility	(	TimeValue	t,
		Interval *	valid = `NULL`
	)

pure virtual

Remarks: Retrieves the visibility of the node at the time passed and updates the validity interval passed. Values < 0 indicate off while values > 0 indicate on. The node is fully visible (opaque) when 1.0 and fully invisible (transparent) when 0.0.

Note: this value may be inherited by the children of this node

Example: // Check visibility

vis = pNode->GetVisibility(t);

if (vis < 0.0f) {

vis = 0.0f;

SetFlag(INST_HIDE, 1);

return 1;

}

if (vis > 1.0f) vis = 1.0f;

Parameters

t	The time to get the visibility value.
valid	The validity interval to update based on the validity of the visibility.

Implemented in INodeTransformed.

virtual float GetVisibility	(	TimeValue	t,
		View &	view,
		Interval *	valid = `NULL`
	)

inlinevirtual

Remarks: Gets the visibility for the node within the specified view at the time passed, and updates the validity. The visibility calculated includes the view dependent Level Of Detail visibility calculated by the Nodes visibility controller. See also Control::EvalVisibility for more info.

Parameters

t	The time to get the visibility value.
view	This is the view to calculate the view-dependent LOD visibility from.
valid	The validity interval to update based on the validity of the visibility.

Returns: The visibility of the node as rendered. Values <= 0 are invisible, and values >= 1 are fully opaque.

931 {return GetVisibility(t,valid);}

INode::GetVisibility

virtual float GetVisibility(TimeValue t, Interval *valid=NULL)=0

virtual void SetVisibility	(	TimeValue	t,
		float	vis
	)

pure virtual

Remarks: Sets the visibility of the node to the value passed at the time passed.

Parameters

t	The time to set the visibility value.
vis	The visibility of the node to set. This is treated like a boolean value where < 0 means off and > 0 means on.

Implemented in INodeTransformed.

virtual float GetLocalVisibility	(	TimeValue	t,
		Interval *	valid = `NULL`
	)

pure virtual

Remarks: Returns the local visibility of the node. The value returned from this method is treated like a boolean value where < 0 means off and > 0 means on. If a node returns TRUE from GetInheritVisibility() then its visibility is determined by this method. If GetInheritVisibility() method returns FALSE then the visibility of the node is determined by GetVisibility().

Note: This value does not take into account the parent nodes visibility, and is not inherited by the children of this node

Parameters

t	The time to get the local visibility value.
valid	The validity interval to update based on the validity of the local visibility controller.

Implemented in INodeTransformed.

virtual BOOL GetInheritVisibility ( )

pure virtual

Remarks: Returns TRUE if the node's visibility is determined by the visibility of the parent of the node; otherwise returns FALSE.

Implemented in INodeTransformed.

virtual void SetInheritVisibility ( BOOL onOff )

pure virtual

Remarks: This method is called to set the state of the node's inherit visibility flag.

Parameters

onOff Pass TRUE to have the node inherit its visibility from its parent; otherwise pass FALSE and the node's visibility will be determine by the node itself (not its parent).

Implemented in INodeTransformed.

virtual void SetRenderOccluded ( BOOL onOff )

pure virtual

Remarks: Sets the state of the node's 'Render Occluded Object' flag.

Parameters

onOff TRUE for on; FALSE for off.

Implemented in INodeTransformed.

virtual BOOL GetRenderOccluded ( )

pure virtual

Remarks: Returns TRUE if the node's 'Render Occluded Object' flag is set; otherwise FALSE.

Implemented in INodeTransformed.

virtual Mtl* GetMtl ( )

pure virtual

Remarks: Returns a pointer to the renderer material for the node. If the value returned is NULL the user has not assigned a material yet. See Class Mtl, Materials, Textures and Maps.

Example: // Get material for node

mtl = node->GetMtl();

if (!mtl) {

// Node has no material, create a dummy material based on wireframe color

// This is done so the renderer does not have to worry about nodes

// without materials. It will, in effect, assure that every node has

// a valid material.

mtl = new DumMtl( (Color)(node->GetWireColor()) );

DebugPrint(_T("\tCreated dummy material for: %s.\n"), node->GetName());

}

Implemented in INodeTransformed.

virtual void SetMtl ( Mtl * matl )

pure virtual

Remarks: Sets the renderer material used by the node. If the value set is NULL it indicates a material has not been assigned. In this case, the renderer uses the wireframe color of the node for rendering. See Class Mtl, Materials, Textures and Maps.

Parameters

matl	The materials used to render the node.

Implemented in INodeTransformed.

virtual Material* Mtls ( )

pure virtual

Remarks: Returns a pointer to the GraphicsWindow materials. See NumMtls() below for the number of entries in this array.

Implemented in INodeTransformed.

virtual int NumMtls ( )

pure virtual

Remarks: Returns the number of entries in the array of Materials returned by Mtls() above.

Implemented in INodeTransformed.

virtual void SetObjOffsetPos ( Point3 p )

pure virtual

Remarks: Sets the position portion of the object offset from the node. See the Advanced Topics section on Transformation and Rotation for an overview of the object offset transformation.

Parameters

p	Specifies the position portion of the object-offset.

Implemented in INodeTransformed.

virtual Point3 GetObjOffsetPos ( )

pure virtual

Remarks: Returns the position portion of the object-offset from the node as a Point3. See the Advanced Topics section on Transformation and Rotation for an overview of the object offset transformation.

Implemented in INodeTransformed.

virtual void SetObjOffsetRot ( Quat q )

pure virtual

Remarks: Sets the rotation portion of the object-offset from the node. See the Advanced Topics section on Transformation and Rotation for an overview of the object offset transformation.

Parameters

q	The rotation offset.

Implemented in INodeTransformed.

virtual Quat GetObjOffsetRot ( )

pure virtual

Remarks: Returns the rotation portion of the object-offset from the node. See the Advanced Topics section on Transformation and Rotation for an overview of the object offset transformation.

Implemented in INodeTransformed.

virtual void SetObjOffsetScale ( ScaleValue sv )

pure virtual

Remarks: Sets the scale portion of the object-offset matrix. See the Advanced Topics section on Transformation and Rotation for an overview of the object offset transformation.

Parameters

sv	The scale portion of the offset. See Class ScaleValue.

Implemented in INodeTransformed.

virtual ScaleValue GetObjOffsetScale ( )

pure virtual

Remarks: Returns the scale portion of the object-offset from the node. See Class ScaleValue. See the Advanced Topics section on Transformation and Rotation for an overview of the object offset transformation.

Implemented in INodeTransformed.

virtual void CenterPivot	(	TimeValue	t,
		BOOL	moveObject
	)

pure virtual

Remarks: Centers the pivot to the object. The effect is the same as Hierarchy Panel/Pivot - [Center to Object or Center to Pivot]

Parameters

[in]	t	- not used
[in]	moveObject	- If true, the object is moved to be centered on the pivot. If false, the pivot is centered on the object

Implemented in INodeTransformed.

virtual void AlignPivot	(	TimeValue	t,
		BOOL	moveObject
	)

pure virtual

Remarks: Resets the pivot alignment. The effect is the same as Hierarchy Panel/Pivot - [Align to Object or Align to Pivot]

Parameters

[in]	t	- not used
[in]	moveObject	- If true, the object is rotated to be aligned with the pivot. If false, the pivot rotation is reset to be realigned with the object

Implemented in INodeTransformed.

virtual void WorldAlignPivot	(	TimeValue	t,
		BOOL	moveObject
	)

pure virtual

Remarks: Aligns the object to the world . The effect is the same as Hierarchy Panel/Pivot/[Affect Pivot Only or Affect Object Only]/ - Align to World

Parameters

[in]	t	- not used
[in]	moveObject	- If true, the object is rotated to be aligned with the world. If false, the pivot rotation is set to be aligned with the world

Implemented in INodeTransformed.

virtual void AlignToParent ( TimeValue t )

pure virtual

Remarks: Aligns the pivot to the node's parent's pivot, or to world if no parent.

Parameters

[in] t - not used

Implemented in INodeTransformed.

virtual void AlignToWorld ( TimeValue t )

pure virtual

Remarks: Aligns the pivot to the to world

Parameters

[in] t - not used

Implemented in INodeTransformed.

virtual void ResetTransform	(	TimeValue	t,
		BOOL	scaleOnly
	)

pure virtual

Remarks: Resets the pivot offset transform. The effect is the same as Hierarchy Panel/Pivot/[Reset Transform or Reset Scale]

Parameters

[in]	t	- not used
[in]	scaleOnly	- If true, reset only the offset scale. Else reset the rotation and scale parts

Implemented in INodeTransformed.

virtual void ResetPivot ( TimeValue t )

pure virtual

Remarks: Resets the pivot transform. The effect is the same as Hierarchy Panel/Pivot/Reset Pivot

Parameters

[in] t - not used

Implemented in INodeTransformed.

virtual bool MayResetTransform ( )

pure virtual

Remarks: Indicates whether a call to ResetTransform() will succeed. The ResetTransform() method also checks this internally, so it's not necessary to check beforehand.

Returns: true if ResetTransform will succeed, false if no change would occur

Implemented in INodeTransformed.

virtual void FlagForeground	(	TimeValue	t,
		BOOL	notify = `TRUE`
	)

pure virtual

Remarks: Flags the node to put it in the foreground. For additional information see Foreground / Background Planes.

Parameters

t	The time to put the node in the foreground.
notify	If TRUE, the reference message REFMSG_FLAGDEPENDENTS with PART_PUT_IN_FG is sent.

Implemented in INodeTransformed.

virtual int IsActiveGrid ( )

pure virtual

Remarks: Determines if this node is the active grid object.

Returns: Nonzero indicates the node is the active grid object; zero indicates it is not.

Implemented in INodeTransformed.

virtual void SetNodeLong ( LONG_PTR l )

pure virtual

Remarks: This method provides temporary storage of data with the node. Data stored with the node is only valid before you return control.

Parameters

l	The data to store with the node.

Implemented in INodeTransformed.

virtual LONG_PTR GetNodeLong ( )

pure virtual

Remarks: Returns the value set by SetNodeLong

Implemented in INodeTransformed.

virtual RenderData* GetRenderData ( )

pure virtual

Remarks: Returns the render data for the node. See Class RenderData.

Implemented in INodeTransformed.

virtual void SetRenderData ( RenderData * rd )

pure virtual

Remarks: Sets the render data for the node.

Parameters

rd	The render data to set.

Implemented in INodeTransformed.

virtual void GetUserPropBuffer ( MSTR & buf )

pure virtual

Remarks: This method allows access to the entire user defined property text buffer.

Parameters

buf	The buffer to hold the user defined property text.

Implemented in INodeTransformed.

virtual void SetUserPropBuffer ( const MSTR & buf )

pure virtual

Remarks: This method allows a developer to set to the entire user defined property text buffer.

Parameters

buf	The buffer containing the user defined property text.

Implemented in INodeTransformed.

virtual BOOL GetUserPropString	(	const MSTR &	key,
		MSTR &	string
	)

pure virtual

Remarks: This method retrieves a string based on the key passed.

Parameters

key	The key (or name) of the user defined property text.
string	Storage for the string to retrieve.

Returns: TRUE if the key was found; otherwise FALSE.

Implemented in INodeTransformed.

virtual BOOL GetUserPropInt	(	const MSTR &	key,
		int &	val
	)

pure virtual

Remarks: Retrieves an integer value from the node based on the key passed.

Parameters

key	The key (or name) of the data to retrieve.
val	Storage for the integer value.

Returns: TRUE if the key was found; otherwise FALSE.

Implemented in INodeTransformed.

virtual BOOL GetUserPropFloat	(	const MSTR &	key,
		float &	val
	)

pure virtual

Remarks: Retrieves a floating point value from the node based on the key passed.

Parameters

key	The key (or name) of the data to retrieve.
val	Storage for the float value.

Returns: TRUE if the key was found; otherwise FALSE.

Implemented in INodeTransformed.

virtual BOOL GetUserPropBool	(	const MSTR &	key,
		BOOL &	b
	)

pure virtual

Remarks: Retrieves a boolean value from the node based on the key passed.

Parameters

key	The key (or name) of the data to retrieve.
b	Storage for the boolean value.

Returns: TRUE if the key was found; otherwise FALSE.

Implemented in INodeTransformed.

virtual void SetUserPropString	(	const MSTR &	key,
		const MSTR &	string
	)

pure virtual

Remarks: Stores a string in the node using the key passed. If the key name already exists it is overwritten; otherwise it is created.

Parameters

key	The key (or name) of the data to store.
string	The string to store.

Implemented in INodeTransformed.

virtual void SetUserPropInt	(	const MSTR &	key,
		int	val
	)

pure virtual

Remarks: Stores an integer value in the node using the key passed. If the key name already exists it is overwritten; otherwise it is created.

Parameters

key	The key (or name) of the data to store.
val	The value to store.

Implemented in INodeTransformed.

virtual void SetUserPropFloat	(	const MSTR &	key,
		float	val
	)

pure virtual

Remarks: Stores a floating point value in the node using the key passed. If the key name already exists it is overwritten; otherwise it is created.

Parameters

key	The key (or name) of the data to store.
val	The value to store.

Implemented in INodeTransformed.

virtual void SetUserPropBool	(	const MSTR &	key,
		BOOL	b
	)

pure virtual

Remarks: Stores a boolean value in the node using the key passed. If the key name already exists it is overwritten; otherwise it is created.

Parameters

key	The key (or name) of the data to store.
b	The value to store.

Implemented in INodeTransformed.

virtual BOOL UserPropExists ( const MSTR & key )

pure virtual

Remarks: This method simply checks to see if a key exists.

Parameters

key	The key string to search for.

Returns: TRUE if the key was found; otherwise FALSE.

Implemented in INodeTransformed.

virtual ULONG GetGBufID ( )

pure virtual

Remarks: Returns the G-Buffer ID of this node. This is the ID available in the BMM_CHAN_NODE_ID channel. See Working with Bitmaps(G-Buffer) for additional details.

Implemented in INodeTransformed.

virtual void SetGBufID ( ULONG id )

pure virtual

Remarks: Sets the G-Buffer ID of this node. This is the ID available in the BMM_CHAN_NODE_ID channel. See Working with Bitmaps(G-Buffer) for additional details.

Parameters

id	The G-Buffer ID.

Implemented in INodeTransformed.

virtual UWORD GetRenderID ( )

inlinevirtual

Remarks: Returns the G-Buffer render ID of the node. This is set by the renderer during a video post render when the BMM_CHAN_NODE_RENDER_ID is requested.

Reimplemented in INodeTransformed.

1222 { return 0xffff; }

virtual void SetRenderID ( UWORD id )

inlinevirtual

Remarks: Sets the G-Buffer render ID of the node. This is set by the renderer during a video post render when the BMM_CHAN_NODE_RENDER_ID is requested. The following methods deal with IK parameters associated with a node.

Reimplemented in INodeTransformed.

1227 {}

virtual ULONG GetHandle ( )

inlinevirtual

Remarks: This method returns the unique node handle. Each node is assigned a unique node handle.

Returns: Zero.

Note: For additional information regarding transformation matrices, see the Advanced Topics section on Transformation and Rotation .

1237 { return kNullHandle; }

INode::kNullHandle

static const ULONG kNullHandle

This represents the value of an invalid node handle.

Definition: inode.h:58

virtual void Move	(	TimeValue	t,
		const Matrix3 &	tmAxis,
		const Point3 &	val,
		BOOL	localOrigin = `FALSE`,
		BOOL	affectKids = `TRUE`,
		int	pivMode = `PIV_NONE`,
		BOOL	ignoreLocks = `FALSE`
	)

pure virtual

Remarks: This method may be called to move the node about the specified axis system. Either the pivot point, or the geometry of the object, or both the pivot and the object may be transformed. Optionally, any children of the node can be counter transformed so they don't move.

Parameters

t	The time to transform the node.
tmAxis	The axis system about which the node is transformed.
val	The amount of the transformation relative to the axis system.
localOrigin	If TRUE the transformation takes place about the nodes local origin; otherwise about the world origin.
affectKids	TRUE If TRUE any child nodes are transformed along with the parent node. If FALSE any children of the node are counter transformed so they don't move.
pivMode	One of the following values: PIV_NONE Move both the pivot point and the geometry of the object. PIV_PIVOT_ONLY Move the pivot point only. PIV_OBJECT_ONLY Move the geometry of the object only.
ignoreLocks	If TRUE any transform locks associated with the node are ignored; otherwise the locks govern the application of the transformation.

Implemented in INodeTransformed.

virtual void Rotate	(	TimeValue	t,
		const Matrix3 &	tmAxis,
		const AngAxis &	val,
		BOOL	localOrigin = `FALSE`,
		BOOL	affectKids = `TRUE`,
		int	pivMode = `PIV_NONE`,
		BOOL	ignoreLocks = `FALSE`
	)

pure virtual

Remarks: This method may be called to rotate the node about the specified axis system. Either the pivot point, or the geometry of the object, or both the pivot and the object may be transformed. Optionally, any children of the node can be counter transformed so they don't rotate.

Parameters

t	The time to transform the node.
tmAxis	The axis system about which the node is transformed.
val	The amount of the transformation.
localOrigin	If TRUE the transformation takes place about the nodes local origin; otherwise about the world origin.
affectKids	If TRUE any child nodes are transformed along with the parent node. If FALSE any children of the node are counter transformed so they don't rotate.
pivMode	One of the following values: PIV_NONE Move both the pivot point and the geometry of the object. PIV_PIVOT_ONLY Move the pivot point only. PIV_OBJECT_ONLY Move the geometry of the object only.
ignoreLocks	If TRUE any transform locks associated with the node are ignored; otherwise the locks govern the application of the transformation.

Implemented in INodeTransformed.

virtual void Rotate	(	TimeValue	t,
		const Matrix3 &	tmAxis,
		const Quat &	val,
		BOOL	localOrigin = `FALSE`,
		BOOL	affectKids = `TRUE`,
		int	pivMode = `PIV_NONE`,
		BOOL	ignoreLocks = `FALSE`
	)

pure virtual

Remarks: This method may be called to rotate the node about the specified axis system. Either the pivot point, or the geometry of the object, or both the pivot and the object may be transformed. Optionally, any children of the node can be counter transformed so they don't rotate.

Parameters

t	The time to transform the node.
tmAxis	The axis system about which the node is transformed.
val	The amount of the transformation.
localOrigin	If TRUE the transformation takes place about the nodes local origin; otherwise about the world origin.
affectKids	If TRUE any child nodes are transformed along with the parent node. If FALSE any children of the node are counter transformed so they don't rotate.
pivMode	One of the following values: PIV_NONE Move both the pivot point and the geometry of the object. PIV_PIVOT_ONLY Move the pivot point only. PIV_OBJECT_ONLY Move the geometry of the object only.
ignoreLocks	If TRUE any transform locks associated with the node are ignored; otherwise the locks govern the application of the transformation.

Implemented in INodeTransformed.

virtual void Scale	(	TimeValue	t,
		const Matrix3 &	tmAxis,
		const Point3 &	val,
		BOOL	localOrigin = `FALSE`,
		BOOL	affectKids = `TRUE`,
		int	pivMode = `PIV_NONE`,
		BOOL	ignoreLocks = `FALSE`
	)

pure virtual

Remarks: This method may be called to scale the node about the specified axis system. Either the pivot point, or the geometry of the object, or both the pivot and the object may be transformed. Optionally, any children of the node can be counter transformed so they don't scale.

Parameters

t	The time to transform the node.
tmAxis	The axis system about which the node is transformed.
val	The amount of the transformation.
localOrigin	If TRUE the transformation takes place about the nodes local origin; otherwise about the world origin.
affectKids	If TRUE any child nodes are transformed along with the parent node. If FALSE any children of the node are counter transformed so they don't scale.
pivMode	One of the following values: PIV_NONE Move both the pivot point and the geometry of the object. PIV_PIVOT_ONLY Move the pivot point only. PIV_OBJECT_ONLY Move the geometry of the object only.
ignoreLocks	If TRUE any transform locks associated with the node are ignored; otherwise the locks govern the application of the transformation.

Implemented in INodeTransformed.

virtual BOOL IsGroupMember ( )

pure virtual

Remarks: Returns TRUE if this node is a member of a group; otherwise FALSE.

Implemented in INodeTransformed.

virtual BOOL IsGroupHead ( )

pure virtual

Remarks: Returns TRUE if this node is the head of a group; otherwise FALSE.

Implemented in INodeTransformed.

virtual BOOL IsOpenGroupMember ( )

inlinevirtual

Remarks: Returns TRUE if this node is a member of an open group; otherwise FALSE.

Default Implementation:: {return 0; }

Reimplemented in INodeTransformed.

1350 {return 0; }

virtual BOOL IsOpenGroupHead ( )

inlinevirtual

Remarks: Returns TRUE if this node is the head of a group and that group is open; otherwise FALSE.

Default Implementation:: {return 0; }

Reimplemented in INodeTransformed.

1355 {return 0; }

virtual void SetGroupMember ( BOOL b )

inlinevirtual

Remarks: A node is marked as a group member or not. This method sets this state.

Parameters

b	TRUE to mark the node as a group member; FALSE to indicate it's not in a group.

Reimplemented in INodeTransformed.

1359 {}

virtual void SetGroupHead ( BOOL b )

inlinevirtual

Remarks: A node is marked as the group head or not. This method sets this state.

Parameters

b	TRUE to mark the node as a group head; FALSE to indicate it's not a group head.

Reimplemented in INodeTransformed.

1363 {}

virtual void SetGroupMemberOpen ( BOOL b )

inlinevirtual

Remarks: A node is marked as an open group member or not. This method sets this state.

Parameters

b	TRUE to mark the node as a open; FALSE to indicate it's not open.

Reimplemented in INodeTransformed.

1367 {}

virtual void SetGroupHeadOpen ( BOOL b )

inlinevirtual

Remarks: A node is marked as being the head of a group and being open or not. This method sets this state.

Parameters

b	TRUE to mark the node as an open group head; FALSE to indicate it's not an open group head.

Reimplemented in INodeTransformed.

1372 {}

virtual float GetPosTaskWeight ( )

inlinevirtual

Remarks: This method returns the position weight for the node.

1379 {return 1.0f;}

virtual float GetRotTaskWeight ( )

inlinevirtual

Remarks: This method returns the rotation weight for the node.

1382 {return 1.0f;}

virtual void SetPosTaskWeight ( float w )

inlinevirtual

Remarks: This method sets the position weight for the node.

Parameters

w	The position weight for the node. This value is >= 0.0.

1386 {}

virtual void SetRotTaskWeight ( float w )

inlinevirtual

Remarks: This method sets the rotation weight for the node.

Parameters

w	The rotation weight for the node. This value is >= 0.0.

1390 {}

virtual BOOL GetTaskAxisState	(	int	which,
		int	axis
	)

inlinevirtual

Remarks: Returns TRUE of FALSE to indicate if the specified axis is set for position or rotation.

Parameters

which	Indicates if the method returns the position state or the rotation state: 0: specifies position; 1: specifies rotation.
axis	The axis to check. Values are as follows: 0: specifies X 1: specifies Y 2: specifies Z.

1400 {return TRUE;}

virtual void SetTaskAxisState	(	int	which,
		int	axis,
		BOOL	onOff
	)

inlinevirtual

Remarks: Sets the specified axis state for position or rotation.

Parameters

which	Indicates if the method returns the position state or the rotation state: 0: specifies position 1: specifies rotation.
axis	The axis to check. Values are as follows: 0: specifies X 1 specifies Y 2 specifies Z
onOff	TRUE for on; FALSE for off.

1411 {}

virtual DWORD GetTaskAxisStateBits ( )

inlinevirtual

Remarks: This method returns the same information as GetTaskAxisState() above.

Returns: The first three bits indicate position X, Y and Z. Then the next three bits indicate rotation X, Y, Z.

1416 {return 127;}

virtual void CreateWSMDerivedObject ( )

inlinevirtual

Remarks: Calling this method will create a WSM derived object for this node if one doesn't already exist.

Default Implementation:: {}

1429 {}

virtual IDerivedObject* GetWSMDerivedObject ( )

inlinevirtual

Remarks: This method pointer to the WSM Derived object for this node. Note that there is at most one WSM derived object per node.

Default Implementation:: {return NULL;}

1435 {return NULL;}

NULL

#define NULL

Definition: autoptr.h:18

virtual CoreExport MaxSDK::AssetManagement::AssetUser GetXRefFile ( int i )

virtual

Remarks: Returns the file asset of the scene xref whose index is passed.

Parameters

i	The zero based index of the scene xref (0 to GetXRefFileCount()-1). {return MaxSDK::AssetManagement::AssetUser();}

virtual void SetXRefFile	(	int	i,
		const MaxSDK::AssetManagement::AssetUser &	file,
		BOOL	reload
	)

inlinevirtual

Remarks: Sets the file asset of the scene xref whose index is passed.

Parameters

i	The zero based index of the scene xref (0 to GetXRefFileCount()-1).
file	The file to set.
reload	TRUE to reload; FALSE to not reload.

Default Implementation:: {}

1455 {}

virtual int GetXRefFileCount ( )

inlinevirtual

Remarks: Returns the number of scene xrefs.

Default Implementation:: {return 0;}

Example: void Xrefutil::MergeAllXrefScenes(HWND hWnd)

{

// *** MergeAllXrefScenes ***

//

// Merges ("binds") all XRef Scenes into the

// current scene. Just using RootNode::BindXRefFile

// will merge in the real scene objects from the xref'd

// scene as real modifiable objects, and delete the

// xref scene link from the scene hierarchy.

INode * pNode = NULL;

int i, numxrefscenes;

INode * pRootNode = m_pInterface->GetRootNode();

if (!pRootNode) {

return;

}

numxrefscenes = pRootNode->GetXRefFileCount();

for (i = 0; i < numxrefscenes; i++) {

pRootNode->BindXRefFile(i);

}

}

1463 {return 0;}

virtual BOOL AddNewXRefFile	(	const MaxSDK::AssetManagement::AssetUser &	file,
		BOOL	loadNow = `TRUE`,
		BOOL	hideInManagerUI = `FALSE`
	)

inlinevirtual

Remarks: Adds the specified file to the scene and optionally updates the scene now.

Parameters

file	The file asset to load.
loadNow	If TRUE the file is loaded immediately and the scene updated; if FALSE the scene is now updated until the user requests it.
hideInManagerUI	If TRUE (default value is FALSE) the scene xref flag XREF_SCENE_HIDEINMANAGERUI will be set, so that the scene xref will not be listed in the scene XRef manager UI.

Returns: TRUE if the XRef was loaded; otherwise FALSE.

Default Implementation:: {return FALSE;}

Example: void Xrefutil::AddNewXrefScene(HWND hWnd)

{

// *** AddNewXrefScene ***

//

// Add new XRef'd Scene to current scene -- simply get the

// name of the .MAX file, and use RootNode::AddNewXRefFile

// to hook that xref'd scene into the current scene hierarchy

//

// Note: Don't confuse XRef scenes with XRef objects.

// XRef scenes live as special children of the (single) root

// node of the current scene, basically as "XRef'd root nodes"

// of the external scene. Note that merged-in XRef Root Nodes

// can come from original scenes that already had another scene

// xref'd in, and so-on. See the SDK documentation on the

// various XRef Scene APIs on the INode object, keeping in mind

// that these APIs only function when the INode is in fact the

// root node of the scene.

//

TSTR filename = _T("");

INode * pRootNode = m_pInterface->GetRootNode();

if (!pRootNode) {

return;

}

if (!DoOpenSaveDialog(filename, true)) {

return;

}

AssetUser asset = IAssetManager::GetInstance()->GetAsset(filename,kXRefAsset);

pRootNode->AddNewXRefFile(asset, TRUE);

m_pInterface->RedrawViews(m_pInterface->GetTime());

}

1477 {return FALSE;}

virtual BOOL DeleteXRefFile ( int i )

inlinevirtual

Remarks: This method removes the 'i-th' Scene XRef.

Parameters

i	The zero based index of the Scene XRef to load.

Returns: TRUE if the file was deleted from the scene; otherwise FALSE.

Default Implementation:: {return FALSE;}

1484 {return FALSE;}

virtual BOOL BindXRefFile ( int i )

inlinevirtual

Remarks: This methods binds the specified XRef. This deletes the XRef after merging it into the scene.

Parameters

i	The zero based index of the XRef to bind.

Returns: TRUE if the file was deleted; otherwise FALSE.

Default Implementation:: {return FALSE;}

Example: See GetXRefFileCount()

1494 {return FALSE;}

virtual void DeleteAllXRefs ( )

inlinevirtual

Remarks: This method deletes all the XRefs from the scene. This is called when loading a new file, resetting or clearing the scene.

Default Implementation:: {}

1500 {}

virtual BOOL ReloadXRef ( int i )

inlinevirtual

Remarks: This method will reload (updates from disk) the specified XRef.

Parameters

i	The zero based index of the XRef to reload.

Returns: TRUE if the XRef was reloaded; otherwise FALSE.

Default Implementation:: {return FALSE;}

Example: void Xrefutil::RefreshAllXrefScenes(HWND hWnd)

{

// *** RefreshAllXrefScenes ***

//

// Refreshes all Xref'd Scenes -- mimics

// MAX's "Update Now" button on XRef Scene dialog,

// with all xref'd scenes selected.

//

// Simply walk through all XRef'd scenes (hanging off root)

// and use RootNode::ReloadXRef() to reload each one.

INode * pNode = NULL;

int i, numxrefscenes;

INode * pRootNode = m_pInterface->GetRootNode();

if (!pRootNode) {

return;

}

numxrefscenes = pRootNode->GetXRefFileCount();

for (i = 0; i < numxrefscenes; i++) {

pRootNode->ReloadXRef(i);

}

}

1510 {return FALSE;}

virtual void FlagXrefChanged ( int i )

inlinevirtual

Remarks: This method indicates that the specified XRef has been changed and should be updated.

Parameters

i	The zero based index of the XRef to flag.

Default Implementation:: {}

1516 {}

virtual BOOL UpdateChangedXRefs ( BOOL redraw = TRUE )

inlinevirtual

Remarks: This method updates all XRefs which have their changed flag set.

Parameters

redraw TRUE to redraw the scene; otherwise FALSE.

Returns: TRUE if the XRefs were loaded okay; otherwise FALSE.

Default Implementation:: {return FALSE;}

1523 {return FALSE;}

virtual INode* GetXRefTree ( int i )

inlinevirtual

Remarks: Returns the root node of the tree for the specified XRef. This method, when called on a root node, will access the various XRef scenes. Note that these can be nested so calling this on the root node of the scene will return the root node of one of the scene XRefs. Calling it on the root node of the scene XRef will get the root node of a nested XRef and so on. Note that this is not the parent of the XRef (see GetXRefParent() below).

Parameters

i	The zero based index of the XRef.

Default Implementation:: {return NULL;}

1535 {return NULL;}

NULL

#define NULL

Definition: autoptr.h:18

virtual INode* GetXRefParent ( int i )

inlinevirtual

Remarks: Returns the parent node of the specified XRef. This is the node in the scene (if any) which the scene XRef is linked to through the special bind function in the scene XRef dialog.

Parameters

i	The zero based index of the XRef.

Default Implementation:: {return NULL;}

1543 {return NULL;}

NULL

#define NULL

Definition: autoptr.h:18

virtual void SetXRefParent	(	int	i,
		INode *	par,
		BOOL	autoOffset = `TRUE`
	)

inlinevirtual

Remarks: Sets the parent of the specified XRef to the node passed.

Parameters

i	The zero based index of the XRef.
par	The parent node to set.
autoOffset	Automatically offset XRef so that it keeps its world TM.

Default Implementation:: {}

1551 {}

virtual BOOL FindUnresolvedXRefs ( Tab< MSTR * > & fnames )

inlinevirtual

Remarks: Generates a table of names for the unresolved XRefs in the scene.

Parameters

fnames The table of names. See Template Class Tab.

Returns: Returns TRUE if there are still unresolved XRefs; otherwise FALSE.

Default Implementation:: {return FALSE;}

1558 {return FALSE;}

virtual void AttemptToResolveUnresolvedXRefs ( )

inlinevirtual

Remarks: This method tries to load any XRefs that are currently unresolved.

Default Implementation:: {}

1563 {}

virtual DWORD GetXRefFlags ( int i )

inlinevirtual

Remarks: Returns the state of flags for the specified XRef.

Parameters

i	The zero based index of the XRef whose flags are returned.

Returns: See XRef Flag Bits.

Default Implementation:: {return 0;}

1570 {return 0;}

virtual void SetXRefFlags	(	int	i,
		DWORD	flag,
		BOOL	onOff
	)

inlinevirtual

Remarks: Sets the state of the specified flags in the specified XRef to on or off.

Parameters

i	The zero based index of the XRef whose flags are set.
flag	See XRef Flag Bits.
onOff	TRUE for on; FALSE for off.

Default Implementation:: {}

1578 {}

virtual bool IsSceneXRefNode ( ) const

inlinevirtual

Remarks: This method tells if the INode is a scene XRef node or not.

Returns: true if the node is a scene XRef node, false otherwise.

1583 { return false; }

virtual void SetBoneNodeOnOff	(	BOOL	onOff,
		TimeValue	t
	)

inlinevirtual

Remarks: Sets the bone on/off property of the node.

Parameters

onOff	Pass TRUE for on; FALSE for off.
t	The time at which to set the property.

Default Implementation:: {}

1594 {}

virtual void SetBoneAutoAlign ( BOOL onOff )

inlinevirtual

Remarks: Sets the bone auto-align property of the node.

Parameters

onOff Pass TRUE for on; FALSE for off.

Default Implementation:: {}

1600 {}

virtual void SetBoneFreezeLen ( BOOL onOff )

inlinevirtual

Remarks: Sets the bone freeze length property of the node.

onOff Pass TRUE for on; FALSE for off.

Default Implementation:: {}

1606 {}

virtual void SetBoneScaleType ( int which )

inlinevirtual

Remarks: Sets the bone scale (stretch) type to the specified value.

Parameters

which One of the following values:

BONE_SCALETYPE_SCALE
BONE_SCALETYPE_SQUASH
BONE_SCALETYPE_NONE

Default Implementation:: {}

1615 {}

virtual void SetBoneAxis ( int which )

inlinevirtual

Remarks: Sets the bone axis of the node to the specified value.

Parameters

which One of the following values:

BONE_AXIS_X
BONE_AXIS_Y
BONE_AXIS_Z

Default Implementation:: {}

1624 {}

virtual void SetBoneAxisFlip ( BOOL onOff )

inlinevirtual

Remarks: Sets the state of the bone axis flip toggle.

Parameters

onOff Pass TRUE for on; FALSE for off.

Default Implementation:: {}

1630 {}

virtual BOOL GetBoneNodeOnOff ( )

inlinevirtual

Remarks: Returns TRUE if the bone property if on; FALSE if off.

Default Implementation:: {return FALSE;}

1635 {return FALSE;}

virtual BOOL GetBoneNodeOnOff_T ( TimeValue t )

inlinevirtual

1637 { return GetBoneNodeOnOff(); } // for write property access via MXS

INode::GetBoneNodeOnOff

virtual BOOL GetBoneNodeOnOff()

Definition: inode.h:1635

virtual BOOL GetBoneAutoAlign ( )

inlinevirtual

Remarks: Returns TRUE if the bone auto-align property is on; FALSE if off.

Default Implementation:: {return FALSE;}

1642 {return FALSE;}

virtual BOOL GetBoneFreezeLen ( )

inlinevirtual

Remarks: Returns TRUE if the freeze length property is on; FALSE if off.

Default Implementation:: {return FALSE;}

1647 {return FALSE;}

virtual int GetBoneScaleType ( )

inlinevirtual

Remarks: Returns a value which indicates the bone scale type.

Returns: One of the following values:

BONE_SCALETYPE_SCALE
BONE_SCALETYPE_SQUASH
BONE_SCALETYPE_NONE

Default Implementation:: {return 0;}

1656 {return 0;}

virtual int GetBoneAxis ( )

inlinevirtual

Remarks: Returns a value which indicates the bone axis.

Returns: One of the following values:

BONE_AXIS_X
BONE_AXIS_Y
BONE_AXIS_Z

Default Implementation:: {return 0;}

1665 {return 0;}

virtual BOOL GetBoneAxisFlip ( )

inlinevirtual

Remarks: Returns TRUE if the axis flip toggle is on; FALSE if off.

Default Implementation:: {return FALSE;}

1670 {return FALSE;}

virtual void RealignBoneToChild ( TimeValue t )

inlinevirtual

Remarks: Calling this method is the equivalent of pressing the Realign button in the UI.

Parameters

t	The time at which to reset the initial child position.

Default Implementation:: {}

1676 {}

virtual void ResetBoneStretch ( TimeValue t )

inlinevirtual

Remarks: Calling this method is the equivalent of pressing the Reset Stretch button in the UI. This will cause the X-axis of the bone to realign to point at the child bone (or average pivot of multiple children).

Parameters

t	The time at which to reset the bone stretch.

Default Implementation:: {}

1684 {}

virtual Matrix3 GetStretchTM	(	TimeValue	t,
		Interval *	valid = `NULL`
	)

inlinevirtual

Remarks: This method returns the strechTM without the object offset included. Normally matrix concatenation occurs in the following manner: objectTM = objectOffsetTM * stretchTM * nodeTM A plug-in that uses the objectTM will transparently inherit the effects of the stretchTM. However if a plug-in (such as skin) wants the stretchTM included but not the object offset, this method will return the stretchTM alone. If the node is not a bone or has no stretching, this method will return the identity.

Parameters

t	The time at which to obtain the strechtTM.
valid	The interval.

Default Implementation:: {return Matrix3(1);}

1699 {return Matrix3(1);}

Matrix3

Definition: matrix3.h:81

BaseInterface* GetInterface ( Interface_ID id )

inlinevirtual

Remarks: Returns a pointer to the interface whose ID is specified.

Parameters:: Interface_ID id

The ID of the interface to return.

Default Implementation:: { return NULL; }

Reimplemented from FPMixinInterface.

1704 { return (id == INODE_INTERFACE) ? this : FPMixinInterface::GetInterface(id); }

INODE_INTERFACE

#define INODE_INTERFACE

Definition: inode.h:37

FPMixinInterface::GetInterface

virtual BaseInterface * GetInterface(Interface_ID id)

Definition: ifnpub.h:595

FPInterfaceDesc* GetDesc ( )

inlinevirtual

Remarks: Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

1705 { return (FPInterfaceDesc*)GetCOREInterface(INODE_INTERFACE); }

INODE_INTERFACE

#define INODE_INTERFACE

Definition: inode.h:37

FPInterfaceDesc

Definition: ifnpub.h:324

GetCOREInterface

CoreExport Interface * GetCOREInterface()

PROP_FNS	(	getPosTaskWeight	,
		GetPosTaskWeight	,
		setPosTaskWeight	,
		SetPosTaskWeight	,
		TYPE_FLOAT
	)

PROP_FNS	(	getRotTaskWeight	,
		GetRotTaskWeight	,
		setRotTaskWeight	,
		SetRotTaskWeight	,
		TYPE_FLOAT
	)

PROP_FNS	(	getBoneAutoAlign	,
		GetBoneAutoAlign	,
		setBoneAutoAlign	,
		SetBoneAutoAlign	,
		TYPE_BOOL
	)

PROP_FNS	(	getBoneFreezeLen	,
		GetBoneFreezeLen	,
		setBoneFreezeLen	,
		SetBoneFreezeLen	,
		TYPE_BOOL
	)

PROP_FNS	(	getBoneScaleType	,
		GetBoneScaleType	,
		setBoneScaleType	,
		SetBoneScaleType	,
		TYPE_ENUM
	)

PROP_FNS	(	getBoneAxis	,
		GetBoneAxis	,
		setBoneAxis	,
		SetBoneAxis	,
		TYPE_ENUM
	)

PROP_FNS	(	getBoneAxisFlip	,
		GetBoneAxisFlip	,
		setBoneAxisFlip	,
		SetBoneAxisFlip	,
		TYPE_BOOL
	)

RO_PROP_TFN	(	getStretchTM	,
		GetStretchTM	,
		TYPE_MATRIX3_BV
	)

PROP_TFNS	(	getBoneNodeOnOff	,
		GetBoneNodeOnOff_T	,
		setBoneNodeOnOff	,
		SetBoneNodeOnOff	,
		TYPE_BOOL
	)

VFNT_1	(	setBoneNodeOnOffM	,
		SetBoneNodeOnOff	,
		TYPE_BOOL
	)

VFNT_0	(	realignBoneToChild	,
		RealignBoneToChild
	)

VFNT_0	(	resetBoneStretch	,
		ResetBoneStretch
	)

PROP_FNS	(	getPrimaryVisibility	,
		GetPrimaryVisibility	,
		setPrimaryVisibility	,
		SetPrimaryVisibility	,
		TYPE_bool
	)

PROP_FNS	(	getSecondaryVisibility	,
		GetSecondaryVisibility	,
		setSecondaryVisibility	,
		SetSecondaryVisibility	,
		TYPE_bool
	)

PROP_FNS	(	getApplyAtmospherics	,
		ApplyAtmospherics	,
		setApplyAtmospherics	,
		SetApplyAtmospherics	,
		TYPE_BOOL
	)

PROP_FNS	(	getCVertMode	,
		GetCVertMode	,
		setCVertMode	,
		SetCVertMode	,
		TYPE_INT
	)

PROP_FNS	(	getShadeCVerts	,
		GetShadeCVerts	,
		setShadeCVerts	,
		SetShadeCVerts	,
		TYPE_INT
	)

PROP_FNS	(	getVertexColorType	,
		GetVertexColorType	,
		setVertexColorType	,
		SetVertexColorType	,
		TYPE_ENUM
	)

PROP_FNS	(	getVertexColorMapChannel	,
		GetVertexColorMapChannel	,
		setVertexColorMapChannel	,
		SetVertexColorMapChannel	,
		TYPE_INT
	)

RO_PROP_FN	(	getNodeHandle	,
		GetHandle	,
		TYPE_DWORD
	)

RO_PROP_FN	(	isSceneXRefNode	,
		IsSceneXRefNode	,
		TYPE_bool
	)

CoreExport void CopyProperties ( INode * from )

Remarks: Calling this method copies the various display, rendering, bone and other general parameters from the "from" object. This is used in Edit(able) Spline and Edit(able) Patch to copy node settings into new nodes created by the "Detach" operations.

Parameters:: INode *frame A pointer to the INode to copy the properties from.

virtual bool WasLoadedByLastMerge ( ) const

inlinevirtual

Remarks: Determines if this node was loaded during last merge

Returns: true if the node was loaded during last merge; otherwise false.

1777 { return false; }

Member Data Documentation

const ULONG kNullHandle = 0

static

This represents the value of an invalid node handle.

INode Class Reference

Class Description

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation