INodeTransformed Class Reference

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/inode.h>

Inheritance diagram for INodeTransformed:

Public Member Functions
	INodeTransformed (INode *n, Matrix3 tm, BOOL dm=TRUE)
void	DisposeTemporary ()
INode *	GetActualINode ()
const MCHAR *	GetName ()
void	SetName (const MCHAR *s)
Matrix3	GetNodeTM (TimeValue t, Interval *valid=NULL)
void	SetNodeTM (TimeValue t, const Matrix3 &m) override
void	InvalidateTreeTM ()
void	InvalidateTM ()
void	InvalidateWS ()
void	InvalidateRect (TimeValue t, bool oldRect)
Matrix3	GetObjectTM (TimeValue time, Interval *valid=NULL)
Matrix3	GetObjTMBeforeWSM (TimeValue time, Interval *valid=NULL)
Matrix3	GetObjTMAfterWSM (TimeValue time, Interval *valid=NULL)
const ObjectState &	EvalWorldState (TimeValue time, BOOL evalHidden=TRUE)
INode *	GetParentNode ()
void	AttachChild (INode *n, int keepTM=1)
void	Detach (TimeValue t, int keepTM=1)
int	NumberOfChildren ()
INode *	GetChildNode (int i)
void	Delete (TimeValue t, int keepChildPosition)
void	Hide (BOOL onOff)
	Controls the hidden state of the node in the scene.
int	IsHidden (DWORD hflags=0, BOOL forRenderer=FALSE)
	Determines if the node is hidden in the scene.
int	IsNodeHidden (BOOL forRenderer=FALSE)
	Returns nonzero if the node is hidden in any way.
void	Freeze (BOOL onOff)
	Controls the frozen state of the node in the scene.
int	IsFrozen ()
	Determines if the node is frozen in any way in the scene.
void	SetShowFrozenWithMtl (BOOL onOff)
int	ShowFrozenWithMtl ()
void	XRayMtl (BOOL onOff)
	Set the X-Ray node property.
int	HasXRayMtl ()
	Returns nonzero if the X-Ray Material display property is on for the node; otherwise zero.
void	IgnoreExtents (BOOL onOff)
	Ignore this node during zoom extents.
int	GetIgnoreExtents ()
	Is this node ignored during zoom extents.
void	BoxMode (BOOL onOff)
int	GetBoxMode ()
void	AllEdges (BOOL onOff)
int	GetAllEdges ()
void	VertTicks (int onOff)
int	GetVertTicks ()
void	BackCull (BOOL onOff)
int	GetBackCull ()
void	SetCastShadows (BOOL onOff)
int	CastShadows ()
void	SetRcvShadows (BOOL onOff)
int	RcvShadows ()
void	SetGenerateCaustics (BOOL onOff)
int	GenerateCaustics ()
void	SetRcvCaustics (BOOL onOff)
int	RcvCaustics ()
void	SetApplyAtmospherics (BOOL onOff)
int	ApplyAtmospherics ()
void	SetGenerateGlobalIllum (BOOL onOff)
int	GenerateGlobalIllum ()
void	SetRcvGlobalIllum (BOOL onOff)
int	RcvGlobalIllum ()
void	SetMotBlur (BOOL onOff)
int	MotBlur ()
float	GetImageBlurMultiplier (TimeValue t)
void	SetImageBlurMultiplier (TimeValue t, float m)
void	SetImageBlurMultController (Control *cont)
Control *	GetImageBlurMultController ()
BOOL	GetMotBlurOnOff (TimeValue t)
void	SetMotBlurOnOff (TimeValue t, BOOL m)
Control *	GetMotBlurOnOffController ()
void	SetMotBlurOnOffController (Control *cont)
void	SetRenderable (BOOL onOff)
int	Renderable ()
void	SetPrimaryVisibility (bool onOff) override
bool	GetPrimaryVisibility () const override
void	SetSecondaryVisibility (bool onOff) override
bool	GetSecondaryVisibility () const override
void	ShowBone (int boneVis)
void	BoneAsLine (int onOff)
BOOL	IsBoneShowing ()
BOOL	IsBoneOnly ()
DWORD	GetWireColor ()
void	SetWireColor (DWORD newcol)
int	IsRootNode ()
int	Selected ()
int	Dependent ()
int	IsTarget ()
void	SetIsTarget (BOOL b)
BOOL	GetTransformLock (int type, int axis)
void	SetTransformLock (int type, int axis, BOOL onOff)
INode *	GetTarget ()
INode *	GetLookatNode ()
Matrix3	GetParentTM (TimeValue t)
int	GetTargetTM (TimeValue t, Matrix3 &m)
Object *	GetObjectRef ()
void	SetObjectRef (Object *o)
Object *	GetObjOrWSMRef ()
Control *	GetTMController ()
BOOL	SetTMController (Control *m3cont)
Control *	GetVisController ()
void	SetVisController (Control *cont)
float	GetVisibility (TimeValue t, Interval *valid=NULL)
void	SetVisibility (TimeValue t, float vis)
float	GetLocalVisibility (TimeValue t, Interval *valid)
BOOL	GetInheritVisibility ()
void	SetInheritVisibility (BOOL onOff)
virtual void	SetRenderOccluded (BOOL onOff)
virtual BOOL	GetRenderOccluded ()
Mtl *	GetMtl ()
void	SetMtl (Mtl *matl)
Material *	Mtls ()
int	NumMtls ()
RenderData *	GetRenderData ()
void	SetRenderData (RenderData *rd)
void	SetObjOffsetPos (Point3 p)
Point3	GetObjOffsetPos ()
void	SetObjOffsetRot (Quat q)
Quat	GetObjOffsetRot ()
void	FlagForeground (TimeValue t, BOOL notify=TRUE)
int	IsActiveGrid ()
void	SetNodeLong (LONG_PTR l)
LONG_PTR	GetNodeLong ()
void	GetUserPropBuffer (MSTR &buf)
void	SetUserPropBuffer (const MSTR &buf)
BOOL	GetUserPropString (const MSTR &key, MSTR &string)
BOOL	GetUserPropInt (const MSTR &key, int &val)
BOOL	GetUserPropFloat (const MSTR &key, float &val)
BOOL	GetUserPropBool (const MSTR &key, BOOL &b)
void	SetUserPropString (const MSTR &key, const MSTR &string)
void	SetUserPropInt (const MSTR &key, int val)
void	SetUserPropFloat (const MSTR &key, float val)
void	SetUserPropBool (const MSTR &key, BOOL b)
BOOL	UserPropExists (const MSTR &key)
MaxSDK::Array< MSTRKeyValuePair >	GetUserPropsAndValues () const
void	SetUserPropsAndValues (MaxSDK::Array< MSTRKeyValuePair > pairs)
ULONG	GetGBufID ()
void	SetGBufID (ULONG id)
UWORD	GetRenderID ()
void	SetRenderID (UWORD id)
CoreExport void	SetObjOffsetScale (ScaleValue sv)
CoreExport ScaleValue	GetObjOffsetScale ()
void	CenterPivot (TimeValue t, BOOL moveObject)
void	AlignPivot (TimeValue t, BOOL moveObject)
void	WorldAlignPivot (TimeValue t, BOOL moveObject)
void	AlignToParent (TimeValue t)
void	AlignToWorld (TimeValue t)
void	ResetTransform (TimeValue t, BOOL scaleOnly)
void	ResetPivot (TimeValue t)
bool	MayResetTransform ()
void	Move (TimeValue t, const Matrix3 &tmAxis, const Point3 &val, BOOL localOrigin=FALSE, BOOL affectKids=TRUE, int pivMode=PIV_NONE, BOOL ignoreLocks=FALSE)
void	Rotate (TimeValue t, const Matrix3 &tmAxis, const AngAxis &val, BOOL localOrigin=FALSE, BOOL affectKids=TRUE, int pivMode=PIV_NONE, BOOL ignoreLocks=FALSE)
void	Rotate (TimeValue t, const Matrix3 &tmAxis, const Quat &val, BOOL localOrigin=FALSE, BOOL affectKids=TRUE, int pivMode=PIV_NONE, BOOL ignoreLocks=FALSE)
void	Scale (TimeValue t, const Matrix3 &tmAxis, const Point3 &val, BOOL localOrigin=FALSE, BOOL affectKids=TRUE, int pivMode=PIV_NONE, BOOL ignoreLocks=FALSE)
BOOL	IsGroupMember ()
BOOL	IsGroupHead ()
BOOL	IsOpenGroupMember ()
BOOL	IsOpenGroupHead ()
void	SetGroupMember (BOOL b)
void	SetGroupHead (BOOL b)
void	SetGroupMemberOpen (BOOL b)
void	SetGroupHeadOpen (BOOL b)
RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
	Receives and responds to messages.
void	CopyProperties (INode *from)
virtual void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
Public Member Functions inherited from INode
virtual void	UnhideObjectAndLayer (bool dolayer=true)
	Makes the node, and optionally the layer, visible in the scene.
virtual int	IsObjectHidden ()
	Returns the hidden state of this node in the scene.
virtual void	UnfreezeObjectAndLayer (bool dolayer=true)
	Unfreeze the node, and optionally its layer.
virtual int	IsObjectFrozen ()
	Test the frozen property of this node.
virtual int	HasObjectXRayMtl ()
	Get the X-Ray node property.
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)
	RO_PROP_FN (isSceneNode, IsSceneNode, TYPE_bool)
CoreExport void *	GetInterface (ULONG id) override
	Inherited from Animatable.
WStr	BuildHierarchyName (bool doQuoted=true, bool isRootIncluded=false)
virtual ULONG	GetHandle ()
virtual int	GetTrajectoryON ()
virtual void	SetTrajectoryON (BOOL onOff)
virtual void	SetMotBlur (int kind)=0
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.
virtual void	SetVertexColorMapChannel (int vcmc)
	set the map channel to be displayed as vertex color.
CoreExport void	CopyProperties (INode *from)
virtual void	SetTargetNodePair (int onOff)
virtual int	GetTargetNodePair ()
virtual float	GetVisibility (TimeValue t, View &view, Interval *valid=NULL)
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 ()
virtual void	CreateWSMDerivedObject ()
virtual IDerivedObject *	GetWSMDerivedObject ()
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
virtual bool	IsSceneNode () const
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)
virtual bool	WasLoadedByLastMerge () const
Public Member Functions inherited from ReferenceTarget
CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
BOOL	IsRefTarget () override
	Checks if this is a ReferenceTarget.
CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference.
CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references.
CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents.
void	BeginDependencyTest ()
	Starts Dependency Test.
BOOL	EndDependencyTest ()
	Ends Dependency Test.
virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target.
virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo.
virtual void	RefDeleted (ReferenceMaker *oldOwner)
	Called after a reference to this is deleted.
virtual void	RefDeletedUndoRedo (RefMakerHandle oldOwner)
	Called after a reference to this is deleted because of undo or redo.
CoreExport RefResult	DeleteAllRefsToMe () override
	Deletes all references to this ReferenceTarget.
CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this.
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.
virtual CoreExport RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object.
virtual CoreExport void	BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
	This method copies base class data from an object to its clone.
CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=nullptr, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS) override
	Notify all dependent RefMakers concerned with the message.
void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline.
virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG.
virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets.
CoreExport void *	GetInterface (ULONG id) override
	Inherited from Animatable.
CoreExport BaseInterface *	GetInterface (Interface_ID id) override
	Inherited from Animatable.
CoreExport	ReferenceTarget ()
	Constructor.
virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents.
CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents.
Public Member Functions inherited from ReferenceMaker
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers.
CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker.
CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item.
CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference.
virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered.
CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual CoreExport IOResult	Save (ISave *isave)
	Called for saving data.
virtual CoreExport IOResult	Save (ISave *isave, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual CoreExport IOResult	Load (ILoad *iload)
	Called for loading data.
virtual CoreExport IOResult	Load (ILoad *iload, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references.
virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in object and its reference hierarchy.
CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags) override
	Enumerate auxiliary files (e.g. bitmaps)
virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration.
virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save.
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.
CoreExport bool	EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
	This method provides a general purpose reference enumerator.
CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget.
BOOL	IsRefMaker () override
	Tells whether it is a ReferenceMaker.
virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not.
virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save.
CoreExport	ReferenceMaker ()
	Constructor.
CoreExport void	DeleteMe ()
	Deletes an instance of this class.
virtual CoreExport int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold.
virtual CoreExport RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference.
Public Member Functions inherited from Animatable
virtual void	FreeCaches ()
virtual int	NumChildren ()
virtual Animatable *	ChildAnim (int i)
virtual CoreExport MSTR	NodeName ()
virtual void	EditTrack ()
virtual CoreExport BOOL	SubAnimSetKeyBufferPresent (int subNum)
	returns true if the sub-anim has a "Set Key" buffer present
virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present
virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim.
virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers.
virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim.
virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers.
virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete.
virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used.
virtual bool	GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
	This method is called to access the object specified name to use for the Maxscript macrorecorder.
CoreExport	Animatable ()
	Constructor.
virtual CoreExport void	DeleteThis ()
	Deletes an instance of this class.
MSTR	ClassName (bool localized=true) const
	Returns the name of the plugin class.
virtual CoreExport Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class.
virtual void	BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev=NULL)
virtual void	EndEditParams (IObjParam *ip, ULONG flags, Animatable *next=NULL)
virtual CoreExport void	ReleaseInterface (ULONG id, void *i)
virtual CoreExport int	SetProperty (ULONG id, void *data)
virtual CoreExport void *	GetProperty (ULONG id)
CoreExport void	AppendProperty (AnimProperty *prop)
	A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs.
CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property.
CoreExport void	AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
	Adds application/plugin specific (custom) data to an Animatable.
CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable.
CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable.
CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable.
virtual int	NumSubs ()
virtual Animatable *	SubAnim (int i)
virtual CoreExport MSTR	SubAnimName (int i, bool localized)
virtual BOOL	CanDeleteSubAnim (int i)
virtual void	DeleteSubAnim (int i)
virtual DWORD	GetSubAnimCurveColor (int subNum)
virtual int	SubNumToRefNum (int subNum)
virtual BOOL	CanCopyAnim ()
CoreExport int	HasSubElements (int type=0)
virtual int	GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	The values max and min should be initialized before calling this function.
virtual ParamDimension *	GetParamDimension (int i)
virtual BOOL	SelectSubAnim (int subNum)
virtual BOOL	BypassTreeView ()
virtual BOOL	BypassTrackBar ()
virtual BOOL	BypassPropertyLevel ()
virtual BOOL	InvisibleProperty ()
virtual int	NumKeys ()
virtual TimeValue	GetKeyTime (int index)
virtual int	GetKeyIndex (TimeValue t)
virtual BOOL	GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
virtual void	CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
virtual void	DeleteKeyAtTime (TimeValue t)
virtual BOOL	IsKeyAtTime (TimeValue t, DWORD flags)
virtual int	GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
virtual int	GetKeySelState (BitArray &sel, Interval range, DWORD flags)
CoreExport void	OpenTreeEntry (int type, DWORD tv)
CoreExport void	CloseTreeEntry (int type, DWORD tv)
CoreExport int	IsTreeEntryOpen (int type, DWORD tv)
CoreExport BOOL	GetSelInTrackView (DWORD tv)
CoreExport void	SetSelInTrackView (DWORD tv, BOOL sel)
CoreExport BOOL	InTrackViewSelSet (int which)
CoreExport void	SetTrackViewSelSet (int which, BOOL inOut)
virtual BOOL	AssignController (Animatable *control, int subAnim)
virtual BOOL	CanAssignController (int subAnim)
	Return true if we can reassign the subanim specified.
virtual BOOL	CanMakeUnique ()
CoreExport int	EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
virtual int	RenderBegin (TimeValue t, ULONG flags=0)
virtual int	RenderEnd (TimeValue t)
virtual CoreExport Interval	GetTimeRange (DWORD flags)
virtual void	EditTimeRange (Interval range, DWORD flags)
virtual void	DeleteTime (Interval iv, DWORD flags)
virtual void	ReverseTime (Interval iv, DWORD flags)
virtual void	ScaleTime (Interval iv, float s)
virtual void	InsertTime (TimeValue ins, TimeValue amount)
virtual BOOL	SupportTimeOperations ()
virtual CoreExport void	MapKeys (TimeMap *map, DWORD flags)
virtual void	DeleteKeys (DWORD flags)
virtual void	DeleteKeyByIndex (int index)
virtual void	SelectKeys (TrackHitTab &sel, DWORD flags)
virtual void	SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
virtual void	SelectSubCurve (int subNum, BOOL sel)
virtual void	SelectKeyByIndex (int i, BOOL sel)
virtual BOOL	IsKeySelected (int i)
virtual void	FlagKey (TrackHitRecord hit)
virtual int	GetFlagKeyIndex ()
virtual int	NumSelKeys ()
virtual void	CloneSelectedKeys (BOOL offset=FALSE)
virtual void	AddNewKey (TimeValue t, DWORD flags)
virtual void	MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
virtual void	ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
virtual void	SelectCurve (BOOL sel)
virtual BOOL	IsCurveSelected ()
	Returns TRUE if the function curve is selected; otherwise returns FALSE.
virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed.
virtual int	GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
virtual void	SetSelKeyCoords (TimeValue t, float val, DWORD flags)
virtual int	SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
virtual CoreExport BOOL	IsAnimated ()
virtual BOOL	CanCopyTrack (Interval iv, DWORD flags)
virtual BOOL	CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
virtual TrackClipObject *	CopyTrack (Interval iv, DWORD flags)
virtual void	PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
virtual BOOL	CanCopySubTrack (int subNum, Interval iv, DWORD flags)
virtual BOOL	CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
virtual TrackClipObject *	CopySubTrack (int subNum, Interval iv, DWORD flags)
virtual void	PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
virtual int	GetTrackVSpace (int lineHeight)
virtual int	HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)
virtual int	PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
virtual int	PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
virtual int	PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual void	EditTrackParams (TimeValue t, ParamDimensionBase *dim, const MCHAR *pname, HWND hParent, IObjParam *ip, DWORD flags)
virtual int	TrackParamsType ()
virtual int	GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	This method is called to calculate the largest and smallest values of the anim.
CoreExport void	AddNoteTrack (NoteTrack *note)
CoreExport void	DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)
CoreExport BOOL	HasNoteTracks ()
CoreExport int	NumNoteTracks ()
CoreExport NoteTrack *	GetNoteTrack (int i)
CoreExport DWORD	DeleteAllNoteTracks ()
virtual void	FreeAllBitmaps ()
virtual void	GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
virtual BOOL	IsSubClassOf (Class_ID classID)
	returns true if the animatable has sub-classed off the given class
virtual CoreExport void	MouseCycleCompleted (TimeValue t)
virtual CoreExport void	MouseCycleStarted (TimeValue t)
virtual int	NumParamBlocks ()
virtual IParamBlock2 *	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...
virtual CoreExport bool	SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
	Returns true if the object is selected in its schematic view.
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"...
virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method...
virtual CoreExport bool	SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship.
virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view...
CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class.
CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container.
CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container.
void	SetAFlag (DWORD mask)
void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags.
bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags.
void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags.
void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags.
bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags.
CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit.
CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit.
CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit.
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
template<class InterfaceType>
InterfaceType *	GetTypedInterface ()
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.
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)

Public Attributes
INode *	node
Matrix3	tm
BOOL	deleteMe

Additional Inherited Members
Public Types inherited from INode
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 ,   isSceneNode , kLastFPFuncID }
enum	{ boneScaleTypeEnum , boneAxisEnum , vertexColorTypeEnum }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
Static Public Member Functions inherited from Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted.
static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object.
static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle.
static CoreExport AnimHandle	GetNextHandle ()
	Get the unique handle for the next Animatable object to be created.
static CoreExport DWORD	GetNumAnimatables ()
	Get the number of existing Animatable objects.
static CoreExport Tab< AnimHandle >	GetExistingAnimatables ()
	Get a list of existing Animatable objects.
static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables.
static CoreExport bool	RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport void	ClearAFlagInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable flags in all Animatables.
static CoreExport void	ClearAFlagExInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable extended flags in all Animatables.
static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index.
static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index.
static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables.
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Static Public Attributes inherited from INode
static constexpr Interface_ID	ID = INODE_INTERFACE
static const ULONG	kNullHandle = 0
	This represents the value of an invalid node handle.
Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Member Functions inherited from ReferenceTarget
CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep) override
	Method to perform an enumeration on a ReferenceTarget.
virtual CoreExport	~ReferenceTarget ()=0
	Destructor.
Protected Member Functions inherited from ReferenceMaker
virtual CoreExport	~ReferenceMaker ()=0
	Destructor.
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`.
void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target.
void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target.
int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target.
CoreExport RefResult	StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
	Validates a given reference link between this reference maker and its reference target.
Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor.
Protected Member Functions inherited from Noncopyable
	Noncopyable ()
	~Noncopyable ()
Protected 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

Detailed Description

See also

Class INode, ~{ Modifier Stack Branching }~

Description:

This class provides a layer that will add in a transformation to the node's objectTM. Most methods pass through to the INode, except for the objectTM methods which pre-multiply in the given matrix. The methods of this class are the same as INode. See Class INode for details. Specifically see the methods related to INodeTransformed in INode - INodeTransformed methods. All methods of this class are implemented by the system.

Data Members:

INode *node;

The original INode pointer.

Matrix3 tm;

The additional transformation.

BOOL deleteMe;

If set to FALSE this INodeTransformed will not get deleted. This may be used if the object is not allocated dynamically. If you create an INodeTransformed on the stack you'll want to set deleteMe to FALSE.

Constructor & Destructor Documentation

INodeTransformed()

INodeTransformed ( INode * n, Matrix3 tm, BOOL dm = TRUE )

inline

{node = n;this->tm = tm;deleteMe = dm;}

Member Function Documentation

DisposeTemporary()

void DisposeTemporary ( )

inlinevirtual

Remarks

Deletes this INodeTransformed.

Reimplemented from INode.

{node->DisposeTemporary(); if (deleteMe) DeleteINodeTransformed(this);}

GetActualINode()

INode * GetActualINode ( )

inlinevirtual

Remarks

Returns the actual INode pointer of this INodeTransformed.

These functions are not part of this class but are available for use:

INodeTransformed can be allocated on the stack, but if you need to create one dynamically, use these methods to create and delete them.

Reimplemented from INode.

{return node->GetActualINode();}

GetName()

const MCHAR * GetName ( )

inlinevirtual

Remarks

Returns the name of the node.

Implements INode.

{return node->GetName();}

SetName()

void SetName ( const MCHAR * s )

inlinevirtual

Remarks

Sets the name of the node.

Parameters

s	The name of the node.

Implements INode.

{node->SetName(s);}

GetNodeTM()

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

inlinevirtual

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.

Implements INode.

{return node->GetNodeTM(t,valid);}

SetNodeTM()

void SetNodeTM ( TimeValue t, const Matrix3 & tm )

inlineoverridevirtual

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.

Implements INode.

{ node->SetNodeTM(t, m); }

InvalidateTreeTM()

void InvalidateTreeTM ( )

inlinevirtual

Remarks

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

Implements INode.

{node->InvalidateTreeTM();}

InvalidateTM()

void InvalidateTM ( )

inlinevirtual

Remarks

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

Implements INode.

{node->InvalidateTM();}

InvalidateWS()

void InvalidateWS ( )

inlinevirtual

Remarks

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

Implements INode.

{node->InvalidateWS();}

InvalidateRect()

void InvalidateRect ( TimeValue t, bool oldRect )

inlinevirtual

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.

Implements INode.

{ node->InvalidateRect(t,oldRect); }

GetObjectTM()

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

inlinevirtual

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.

Implements INode.

{return tm*node->GetObjectTM(time,valid);}

GetObjTMBeforeWSM()

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

inlinevirtual

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.

Implements INode.

{return tm*node->GetObjTMBeforeWSM(time,valid);}

GetObjTMAfterWSM()

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

inlinevirtual

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.

Implements INode.

{return tm*node->GetObjTMAfterWSM(time,valid);}

EvalWorldState()

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

inlinevirtual

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;
   }
}

Implements INode.

{return node->EvalWorldState(time,evalHidden);}

GetParentNode()

INode * GetParentNode ( )

inlinevirtual

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;
        }
    }

Implements INode.

{return node->GetParentNode();}

AttachChild()

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

inlinevirtual

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.

Implements INode.

{node->AttachChild(n,keepTM);}

Detach()

void Detach ( TimeValue t, int keepTM = 1 )

inlinevirtual

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.

Implements INode.

{node->Detach(t,keepTM);}

NumberOfChildren()

int NumberOfChildren ( )

inlinevirtual

Remarks

Returns the number of children of this node.

Implements INode.

{return node->NumberOfChildren();}

GetChildNode()

INode * GetChildNode ( int i )

inlinevirtual

Remarks

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

Parameters

i	Specifies the child node to retrieve.

Implements INode.

{return node->GetChildNode(i);}

Delete()

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 from INode.

{ node->Delete(t,keepChildPosition); } 

Hide()

void Hide ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{node->Hide(onOff);}

IsHidden()

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 from INode.

{return node->IsHidden(hflags,forRenderer);}

IsNodeHidden()

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 from INode.

{ return node->IsNodeHidden(forRenderer); }

Freeze()

void Freeze ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{node->Freeze(onOff);}

IsFrozen()

int IsFrozen ( )

inlinevirtual

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.

Implements INode.

{return node->IsFrozen();}

SetShowFrozenWithMtl()

void SetShowFrozenWithMtl ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{node->SetShowFrozenWithMtl(onOff);}

ShowFrozenWithMtl()

int ShowFrozenWithMtl ( )

inlinevirtual

Remarks

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

Implements INode.

{return node->ShowFrozenWithMtl();}

XRayMtl()

void XRayMtl ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{node->XRayMtl(onOff);}

HasXRayMtl()

int HasXRayMtl ( )

inlinevirtual

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

Implements INode.

{return node->HasXRayMtl();}

IgnoreExtents()

void IgnoreExtents ( BOOL onOff )

inlinevirtual

Ignore this node during zoom extents.

Parameters

onOff

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

Implements INode.

{node->IgnoreExtents(onOff);}

GetIgnoreExtents()

int GetIgnoreExtents ( )

inlinevirtual

Is this node ignored during zoom extents.

Returns

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

Implements INode.

{return node->GetIgnoreExtents();}

BoxMode()

void BoxMode ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{node->BoxMode(onOff);}

GetBoxMode()

int GetBoxMode ( )

inlinevirtual

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.

Implements INode.

{return node->GetBoxMode();}

AllEdges()

void AllEdges ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{node->AllEdges(onOff);}

GetAllEdges()

int GetAllEdges ( )

inlinevirtual

Remarks

Determines if all the edges of the node are displayed.

Returns

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

Implements INode.

{return node->GetAllEdges();}

VertTicks()

void VertTicks ( int onOff )

inlinevirtual

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.

Implements INode.

{node->VertTicks(onOff);}

GetVertTicks()

int GetVertTicks ( )

inlinevirtual

Remarks

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

Implements INode.

{return node->GetVertTicks();}

BackCull()

void BackCull ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{node->BackCull(onOff);}

GetBackCull()

int GetBackCull ( )

inlinevirtual

Remarks

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

Returns

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

Implements INode.

{return node->GetBackCull();}

SetCastShadows()

void SetCastShadows ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{ node->SetCastShadows(onOff); } 

CastShadows()

int CastShadows ( )

inlinevirtual

Remarks

Retrieves the shadow casting attribute of the node.

Returns

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

Implements INode.

{ return node->CastShadows(); }

SetRcvShadows()

void SetRcvShadows ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{ node->SetRcvShadows(onOff); }

RcvShadows()

int RcvShadows ( )

inlinevirtual

Remarks

Retrieves the shadow receiving attribute of the node.

Returns

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

Implements INode.

{ return node->RcvShadows(); }

SetGenerateCaustics()

void SetGenerateCaustics ( BOOL onOff )

inlinevirtual

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.

Reimplemented from INode.

{ node->SetGenerateCaustics(onOff); } 

GenerateCaustics()

int GenerateCaustics ( )

inlinevirtual

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.

Reimplemented from INode.

{ return node->GenerateCaustics(); }

SetRcvCaustics()

void SetRcvCaustics ( BOOL onOff )

inlinevirtual

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.

Reimplemented from INode.

{ node->SetRcvCaustics(onOff); }

RcvCaustics()

int RcvCaustics ( )

inlinevirtual

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.

Reimplemented from INode.

{ return node->RcvCaustics(); }

SetApplyAtmospherics()

void SetApplyAtmospherics ( BOOL onOff )

inlinevirtual

Remarks

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

Parameters

onOff

TRUE to enable the flag, FALSE to disable.

Implements INode.

{ node->SetApplyAtmospherics(onOff); }

ApplyAtmospherics()

int ApplyAtmospherics ( )

inlinevirtual

Remarks

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

Implements INode.

{ return node->ApplyAtmospherics(); }

SetGenerateGlobalIllum()

void SetGenerateGlobalIllum ( BOOL onOff )

inlinevirtual

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.

Reimplemented from INode.

{ node->SetGenerateGlobalIllum(onOff); } 

GenerateGlobalIllum()

int GenerateGlobalIllum ( )

inlinevirtual

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.

Reimplemented from INode.

{ return node->GenerateGlobalIllum(); }

SetRcvGlobalIllum()

void SetRcvGlobalIllum ( BOOL onOff )

inlinevirtual

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.

Reimplemented from INode.

{ node->SetRcvGlobalIllum(onOff); }

RcvGlobalIllum()

int RcvGlobalIllum ( )

inlinevirtual

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.

Reimplemented from INode.

{ return node->RcvGlobalIllum(); }

SetMotBlur()

void SetMotBlur ( BOOL onOff )

inline

{ node->SetMotBlur(onOff); }

MotBlur()

int MotBlur ( )

inlinevirtual

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.

Implements INode.

{ return node->MotBlur(); }

GetImageBlurMultiplier()

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 from INode.

{ return node->GetImageBlurMultiplier(t);}

SetImageBlurMultiplier()

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 from INode.

{node->SetImageBlurMultiplier(t,m); };

SetImageBlurMultController()

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 from INode.

{ node->SetImageBlurMultController(cont); }

GetImageBlurMultController()

Control * GetImageBlurMultController ( )

inlinevirtual

Remarks

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

Reimplemented from INode.

{return node->GetImageBlurMultController(); }

GetMotBlurOnOff()

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 from INode.

{ return node->GetMotBlurOnOff(t); }

SetMotBlurOnOff()

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 from INode.

{ node->SetMotBlurOnOff(t,m); }

GetMotBlurOnOffController()

Control * GetMotBlurOnOffController ( )

inlinevirtual

Remarks

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

Default Implementation:

{ return NULL;}

Reimplemented from INode.

{ return node->GetMotBlurOnOffController();}

SetMotBlurOnOffController()

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 from INode.

{ node->SetMotBlurOnOffController(cont);}

SetRenderable()

void SetRenderable ( BOOL onOff )

inlinevirtual

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.

Implements INode.

{ node->SetRenderable(onOff); }

Renderable()

int Renderable ( )

inlinevirtual

Remarks

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

Implements INode.

{ return node->Renderable(); }

SetPrimaryVisibility()

void SetPrimaryVisibility ( bool onOff )

inlineoverridevirtual

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.

Implements INode.

{ node->SetPrimaryVisibility(onOff); }

GetPrimaryVisibility()

bool GetPrimaryVisibility ( ) const

inlineoverridevirtual

Remarks

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

Implements INode.

{ return node->GetPrimaryVisibility(); }

SetSecondaryVisibility()

void SetSecondaryVisibility ( bool onOff )

inlineoverridevirtual

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.

Implements INode.

{ node->SetSecondaryVisibility(onOff); }

GetSecondaryVisibility()

bool GetSecondaryVisibility ( ) const

inlineoverridevirtual

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.

Implements INode.

{ return node->GetSecondaryVisibility(); }

ShowBone()

void ShowBone ( int boneVis )

inlinevirtual

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.

Implements INode.

{node->ShowBone(boneVis);}

BoneAsLine()

void BoneAsLine ( int onOff )

inlinevirtual

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.

Implements INode.

{node->BoneAsLine(onOff);}

IsBoneShowing()

BOOL IsBoneShowing ( )

inlinevirtual

Remarks

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

Implements INode.

{return node->IsBoneShowing();}

IsBoneOnly()

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 from INode.

{ return node->IsBoneOnly(); }

GetWireColor()

DWORD GetWireColor ( )

inlinevirtual

Remarks

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

Implements INode.

{return node->GetWireColor();}

SetWireColor()

void SetWireColor ( DWORD newcol )

inlinevirtual

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

Implements INode.

{node->SetWireColor(newcol);}

IsRootNode()

int IsRootNode ( )

inlinevirtual

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.

Implements INode.

{return node->IsRootNode();}

Selected()

int Selected ( )

inlinevirtual

Remarks

Determines if the node is selected.

Returns

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

Implements INode.

{return node->Selected();}

Dependent()

int Dependent ( )

inlinevirtual

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.

Implements INode.

{return node->Dependent();}

IsTarget()

int IsTarget ( )

inlinevirtual

Remarks

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

Returns

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

Implements INode.

{return node->IsTarget();}

SetIsTarget()

void SetIsTarget ( BOOL b )

inlinevirtual

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.

Implements INode.

{ node->SetIsTarget(b);}

GetTransformLock()

BOOL GetTransformLock ( int type, int axis )

inlinevirtual

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.

Implements INode.

{return node->GetTransformLock(type,axis);}

SetTransformLock()

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

inlinevirtual

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.

Implements INode.

{node->SetTransformLock(type,axis,onOff);}

GetTarget()

INode * GetTarget ( )

inlinevirtual

Remarks

Retrieves this node's target node if any.

Returns

NULL if this node has no target.

Implements INode.

{return node->GetTarget();}

GetLookatNode()

INode * GetLookatNode ( )

inlinevirtual

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.

Implements INode.

{return node->GetLookatNode();}

GetParentTM()

Matrix3 GetParentTM ( TimeValue t )

inlinevirtual

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.

Implements INode.

{return node->GetParentTM(t);}

GetTargetTM()

int GetTargetTM ( TimeValue t, Matrix3 & m )

inlinevirtual

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.

Implements INode.

{return node->GetTargetTM(t,m);}

GetObjectRef()

Object * GetObjectRef ( )

inlinevirtual

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.

Implements INode.

{return node->GetObjectRef();}

SetObjectRef()

void SetObjectRef ( Object * o )

inlinevirtual

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.

Implements INode.

{node->SetObjectRef(o);}

GetObjOrWSMRef()

Object * GetObjOrWSMRef ( )

inlinevirtual

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.

Implements INode.

{ return node->GetObjOrWSMRef();}  

GetTMController()

Control * GetTMController ( )

inlinevirtual

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

Implements INode.

{return node->GetTMController();}

SetTMController()

BOOL SetTMController ( Control * m3cont )

inlinevirtual

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.

Implements INode.

{ return node->SetTMController(m3cont);}        

GetVisController()

Control * GetVisController ( )

inlinevirtual

Remarks

Returns the visibility controller for this node.

Implements INode.

{return node->GetVisController();}

SetVisController()

void SetVisController ( Control * cont )

inlinevirtual

Remarks

Sets the visibility controller for this node.

Parameters

cont	The controller to use for visibility control.

Implements INode.

{node->SetVisController(cont);}

GetVisibility()

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

inlinevirtual

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.

Implements INode.

{return node->GetVisibility(t,valid);}

SetVisibility()

void SetVisibility ( TimeValue t, float vis )

inlinevirtual

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.

Implements INode.

{ node->SetVisibility(t,vis); }

GetLocalVisibility()

float GetLocalVisibility ( TimeValue t, Interval * valid )

inlinevirtual

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.

Implements INode.

{ return node->GetLocalVisibility(t,valid); }

GetInheritVisibility()

BOOL GetInheritVisibility ( )

inlinevirtual

Remarks

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

Implements INode.

{ return node->GetInheritVisibility(); }

SetInheritVisibility()

void SetInheritVisibility ( BOOL onOff )

inlinevirtual

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

Implements INode.

{ node->SetInheritVisibility(onOff); }

SetRenderOccluded()

virtual void SetRenderOccluded ( BOOL onOff )

inlinevirtual

Remarks

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

Parameters

onOff

TRUE for on; FALSE for off.

Implements INode.

{ node->SetRenderOccluded(onOff); }

GetRenderOccluded()

virtual BOOL GetRenderOccluded ( )

inlinevirtual

Remarks

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

Implements INode.

{ return node->GetRenderOccluded(); }

GetMtl()

Mtl * GetMtl ( )

inlinevirtual

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

Implements INode.

{ return node->GetMtl(); }

SetMtl()

void SetMtl ( Mtl * matl )

inlinevirtual

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.

Implements INode.

{ node->SetMtl(matl); }

Mtls()

Material * Mtls ( )

inlinevirtual

Remarks

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

Implements INode.

{ return node->Mtls(); }    

NumMtls()

int NumMtls ( )

inlinevirtual

Remarks

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

Implements INode.

{ return node->NumMtls(); }

GetRenderData()

RenderData * GetRenderData ( )

inlinevirtual

Remarks

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

Implements INode.

{return node->GetRenderData();}

SetRenderData()

void SetRenderData ( RenderData * rd )

inlinevirtual

Remarks

Sets the render data for the node.

Parameters

rd	The render data to set.

Implements INode.

{node->SetRenderData(rd);}

SetObjOffsetPos()

void SetObjOffsetPos ( Point3 p )

inlinevirtual

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.

Implements INode.

{node->SetObjOffsetPos(p);}

GetObjOffsetPos()

Point3 GetObjOffsetPos ( )

inlinevirtual

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.

Implements INode.

{return node->GetObjOffsetPos();}

SetObjOffsetRot()

void SetObjOffsetRot ( Quat q )

inlinevirtual

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.

Implements INode.

{node->SetObjOffsetRot(q);}

GetObjOffsetRot()

Quat GetObjOffsetRot ( )

inlinevirtual

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.

Implements INode.

{return node->GetObjOffsetRot();}       

FlagForeground()

void FlagForeground ( TimeValue t, BOOL notify = TRUE )

inlinevirtual

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.

Implements INode.

{node->FlagForeground(t,notify);}

IsActiveGrid()

int IsActiveGrid ( )

inlinevirtual

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.

Implements INode.

{return node->IsActiveGrid();}

SetNodeLong()

void SetNodeLong ( LONG_PTR l )

inlinevirtual

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.

Implements INode.

{node->SetNodeLong(l);}

GetNodeLong()

LONG_PTR GetNodeLong ( )

inlinevirtual

Remarks

Returns the value set by SetNodeLong

Implements INode.

{return node->GetNodeLong();}

GetUserPropBuffer()

void GetUserPropBuffer ( MSTR & buf )

inlinevirtual

Remarks

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

Parameters

buf	The buffer to hold the user defined property text.

Implements INode.

{node->GetUserPropBuffer(buf);}

SetUserPropBuffer()

void SetUserPropBuffer ( const MSTR & buf )

inlinevirtual

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.

Implements INode.

{node->SetUserPropBuffer(buf);}

GetUserPropString()

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

inlinevirtual

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.

Implements INode.

{return node->GetUserPropString(key,string);}

GetUserPropInt()

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

inlinevirtual

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.

Implements INode.

{return node->GetUserPropInt(key,val);}

GetUserPropFloat()

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

inlinevirtual

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.

Implements INode.

{return node->GetUserPropFloat(key,val);}

GetUserPropBool()

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

inlinevirtual

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.

Implements INode.

{return node->GetUserPropBool(key,b);}

SetUserPropString()

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

inlinevirtual

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.

Implements INode.

{node->SetUserPropString(key,string);}

SetUserPropInt()

void SetUserPropInt ( const MSTR & key, int val )

inlinevirtual

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.

Implements INode.

{node->SetUserPropInt(key,val);}

SetUserPropFloat()

void SetUserPropFloat ( const MSTR & key, float val )

inlinevirtual

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.

Implements INode.

{node->SetUserPropFloat(key,val);}

SetUserPropBool()

void SetUserPropBool ( const MSTR & key, BOOL b )

inlinevirtual

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.

Implements INode.

{node->SetUserPropBool(key,b);}

UserPropExists()

BOOL UserPropExists ( const MSTR & key )

inlinevirtual

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.

Implements INode.

{return node->UserPropExists(key);}

GetUserPropsAndValues()

MaxSDK::Array< MSTRKeyValuePair > GetUserPropsAndValues ( ) const

inlinevirtual

Remarks

This method returns an array of key/value pairs.

Implements INode.

{return node->GetUserPropsAndValues();}

SetUserPropsAndValues()

void SetUserPropsAndValues ( MaxSDK::Array< MSTRKeyValuePair > pairs )

inlinevirtual

Remarks

This method sets the user property buffer based on an array of key/value pairs.

Parameters

pairs

The array of key/value pairs.

Implements INode.

{node->SetUserPropsAndValues(pairs);}

GetGBufID()

ULONG GetGBufID ( )

inlinevirtual

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.

Implements INode.

{ return node->GetGBufID(); }

SetGBufID()

void SetGBufID ( ULONG id )

inlinevirtual

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.

Implements INode.

{ node->SetGBufID(id); }

GetRenderID()

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 from INode.

{ return node->GetRenderID(); }

SetRenderID()

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 from INode.

{ node->SetRenderID(id); }

SetObjOffsetScale()

CoreExport void SetObjOffsetScale ( ScaleValue sv )

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.

Implements INode.

GetObjOffsetScale()

CoreExport ScaleValue GetObjOffsetScale ( )

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.

Implements INode.

CenterPivot()

void CenterPivot ( TimeValue t, BOOL moveObject )

inlinevirtual

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

Implements INode.

{ node->CenterPivot(t,moveObject); }

AlignPivot()

void AlignPivot ( TimeValue t, BOOL moveObject )

inlinevirtual

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

Implements INode.

{ node->AlignPivot(t,moveObject); }

WorldAlignPivot()

void WorldAlignPivot ( TimeValue t, BOOL moveObject )

inlinevirtual

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

Implements INode.

{ node->WorldAlignPivot(t,moveObject); }

AlignToParent()

void AlignToParent ( TimeValue t )

inlinevirtual

Remarks

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

Parameters

[in]

t

- not used

Implements INode.

{ node->AlignToParent(t); }

AlignToWorld()

void AlignToWorld ( TimeValue t )

inlinevirtual

Remarks

Aligns the pivot to the to world

Parameters

[in]

t

- not used

Implements INode.

{ node->AlignToWorld(t); }

ResetTransform()

void ResetTransform ( TimeValue t, BOOL scaleOnly )

inlinevirtual

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

Implements INode.

{ node->ResetTransform(t,scaleOnly); }

ResetPivot()

void ResetPivot ( TimeValue t )

inlinevirtual

Remarks

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

Parameters

[in]

t

- not used

Implements INode.

{ node->ResetPivot(t); }

MayResetTransform()

bool MayResetTransform ( )

inlinevirtual

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

Implements INode.

{ return node->MayResetTransform(); }

Move()

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

inlinevirtual

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.

Implements INode.

{node->Move(t,tmAxis,val,localOrigin,pivMode,ignoreLocks);}

Rotate() [1/2]

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

inlinevirtual

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.

Implements INode.

{node->Rotate(t,tmAxis,val,localOrigin,pivMode,ignoreLocks);}

Rotate() [2/2]

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

inlinevirtual

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.

Implements INode.

{node->Rotate(t,tmAxis,val,localOrigin,pivMode,ignoreLocks);}

Scale()

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

inlinevirtual

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.

Implements INode.

{node->Scale(t,tmAxis,val,localOrigin,pivMode,ignoreLocks);}

IsGroupMember()

BOOL IsGroupMember ( )

inlinevirtual

Remarks

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

Implements INode.

{return node->IsGroupMember();}

IsGroupHead()

BOOL IsGroupHead ( )

inlinevirtual

Remarks

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

Implements INode.

{ return node->IsGroupHead();}

IsOpenGroupMember()

BOOL IsOpenGroupMember ( )

inlinevirtual

Remarks

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

Default Implementation:

{return 0; }

Reimplemented from INode.

{return node->IsOpenGroupMember();}

IsOpenGroupHead()

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 from INode.

{return node->IsOpenGroupHead();}

SetGroupMember()

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 from INode.

{ node->SetGroupMember(b); }

SetGroupHead()

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 from INode.

{ node->SetGroupHead(b); }

SetGroupMemberOpen()

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 from INode.

{ node->SetGroupMemberOpen(b); }

SetGroupHeadOpen()

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 from INode.

{ node->SetGroupHeadOpen(b); }

NotifyRefChanged()

RefResult NotifyRefChanged ( const Interval & changeInt, RefTargetHandle hTarget, PartID & partID, RefMessage message, BOOL propagate )

inlinevirtual

Receives and responds to messages.

A plugin which makes references must implement a method to receive and respond to messages broadcast by its dependents. This is done by implementing NotifyRefChanged(). The plugin developer usually implements this method as a switch statement where each case is one of the messages the plugin needs to respond to. The Method StdNotifyRefChanged calls this, which can change the partID to new value. If it doesn't depend on the particular message& partID, it should return REF_DONTCARE.

• For developer that need to update a dialog box with data about an object you reference note the following related to this method: This method may be called many times. For instance, say you have a dialog box that displays data about an object you reference. This method will get called many time during the drag operations on that object. If you updated the display every time you'd wind up with a lot of 'flicker' in the dialog box. Rather than updating the dialog box each time, you should just invalidate the window in response to the NotifyRefChanged() call. Then, as the user drags the mouse your window will still receive paint messages. If the scene is complex the user may have to pause (but not let up on the mouse) to allow the paint message to go through since they have a low priority. This is the way many windows in 3ds Max work.

Parameters

changeInt	- This is the interval of time over which the message is active. Currently, all plug-ins will receive FOREVER for this interval, with the exception of REFMSG_FLAGDEPENDENTS notifications. In that case, changeInt.Start() is the timepoint to perform the dependency test.
hTarget	- This is the handle of the reference target the message was sent by. The reference maker uses this handle to know specifically which reference target sent the message.
partID	- This contains information specific to the message passed in. Some messages don't use the partID at all. See the section List of Reference Messages for more information about the meaning of the partID for some common messages.
message	- The message parameters passed into this method is the specific message which needs to be handled.
propagate	- If called through ReferenceMaker::NotifyDependents(), the value of 'propagate' passed to it. Used if calling NotifyDependents() from within NotifyRefChanged().

Returns

The return value from this method is of type RefResult. This is usually REF_SUCCEED indicating the message was processed. Sometimes, the return value may be REF_STOP. This return value is used to stop the message from being propagated to the dependents of the item.

Implements ReferenceMaker.

                                                            {return REF_SUCCEED;}

CopyProperties()

void CopyProperties ( INode * from )

inline

{node->CopyProperties(from);}

GetClassName()

virtual void GetClassName ( MSTR & s, bool localized = true ) const

inlineoverridevirtual

Retrieves the name of the plugin class.

This name is used in 3ds Max's UI and in MAXScript. For Material plug-ins this method is used to put up the material "type" name in the Material Editor.

Parameters

s	Reference to a string filled in with the name of the plugin class.
localized	If true, then the class name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the class name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the class name in English.

Reimplemented from Animatable.

{ UNUSED_PARAM(localized); s = _M("INodeTransformed"); } // from Animatable

Member Data Documentation

node

INode* node

tm

Matrix3 tm

deleteMe

BOOL deleteMe