3ds Max C++ API Reference
Loading...
Searching...
No Matches
IXRefObject8 Class Referenceabstract

Class representing Xref objects. More...

#include <iXrefObj.h>

+ Inheritance diagram for IXRefObject8:

Public Types

enum  { kfpGetActiveFileName , kfpGetActiveObjName , kfpGetActiveRecord , kfpGetSourceObject }
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
 

Public Member Functions

virtual const MaxSDK::AssetManagement::AssetUserGetActiveFile () const =0
 Retrieves the active source file

 
virtual const MCHARGetActiveObjName () const =0
 Retrieves the active source item name.
 
virtual IObjXRefRecordGetActiveRecord () const =0
 Retrieves the active xref record this xref object belongs to.
 
virtual ObjectGetSourceObject (bool resolveNested=false, Tab< Modifier * > *modifiers=NULL) const =0
 Retrieves the actual source object behind the XRef.
 
virtual Interface_ID GetID ()
 Gets the interface ID.
 
 RO_PROP_FN (kfpGetActiveFileName, FPGetActiveFileName, TYPE_FILENAME)
 
 RO_PROP_FN (kfpGetActiveObjName, GetActiveObjName, TYPE_STRING)
 
 RO_PROP_FN (kfpGetActiveRecord, GetActiveRecord, TYPE_INTERFACE)
 
 FN_2 (kfpGetSourceObject, TYPE_REFTARG, FPGetSourceObject, TYPE_bool, TYPE_REFTARG_TAB_BR)
 
virtual FPInterfaceDescGetDesc ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
- Public Member Functions inherited from IXRefObject
Class_ID ClassID ()
 Retrieves a constant that uniquely identifies the plugin class.
 
SClass_ID SuperClassID ()
 Retrieves a constant representing the type of the plugin.
 
virtual void Init (const MaxSDK::AssetManagement::AssetUser &asset, const MSTR &oname, Object *ob, BOOL asProxy=FALSE)=0
 
virtual void SetFile (const MaxSDK::AssetManagement::AssetUser &asset, BOOL proxy=FALSE, BOOL update=TRUE)=0
 
virtual void SetObjName (const MCHAR *name, BOOL proxy=FALSE)=0
 
virtual void SetUseProxy (BOOL onOff, BOOL redraw=TRUE)=0
 
virtual void SetRenderProxy (BOOL onOff)=0
 
virtual void SetUpdateMats (BOOL onOff)=0
 
virtual void SetIgnoreAnim (BOOL onOff, BOOL redraw=TRUE)=0
 
virtual const MaxSDK::AssetManagement::AssetUserGetFile (BOOL proxy=FALSE) const =0
 
virtual MSTR GetObjName (BOOL proxy=FALSE) const =0
 
virtual const MaxSDK::AssetManagement::AssetUserGetCurFile () const =0
 
virtual void SetCurFile (const MaxSDK::AssetManagement::AssetUser &)=0
 
virtual const MSTRGetCurObjName () const =0
 
virtual void SetCurObjName (const MCHAR *name)=0
 
virtual BOOL GetUseProxy ()=0
 
virtual BOOL GetRenderProxy ()=0
 
virtual BOOL GetUpdateMats ()=0
 
virtual BOOL GetIgnoreAnim ()=0
 
virtual void BrowseObject (BOOL proxy)=0
 
virtual void BrowseFile (BOOL proxy)=0
 
virtual void ReloadXRef ()=0
 
- Public Member Functions inherited from Object
CoreExport Object ()
 
CoreExport ~Object ()
 
virtual BOOL CheckObjectIntegrity ()
 This method is used for debugging only.
 
virtual BOOL HasUVW () override
 Call this method to find out if the object has UVW coordinates.
 
virtual BOOL HasUVW (int mapChannel) override
 Call this method to find out if the object is has UVW coordinates for the specified mapping channel.
 
virtual ObjectFindBaseObject ()
 It is called to return a pointer to the base object (an object that is not a derived object).
 
virtual BOOL IsParamSurface ()
 There are several methods used to access a parametric position on the surface of the object.
 
virtual int NumSurfaces (TimeValue t)
 Returns the number of parametric surfaces within the object.
 
virtual Point3 GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
 This method needs to be implemented if Object::IsParamSurface() returns TRUE.
 
virtual Point3 GetSurfacePoint (TimeValue t, int surface, float u, float v, Interval &iv)
 This method is used to retrieve a point on the specified surface of the object based on two parameters of the surface, u and v.
 
virtual void SurfaceClosed (TimeValue t, int surface, BOOL &uClosed, BOOL &vClosed)
 This method allows the object to return flags that indicate whether the parametric surface is closed in the U and V dimensions.
 
virtual BOOL GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
 This method allows an object to return extended Properties fields.
 
CoreExport SvGraphNodeReference SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
 
CoreExport bool SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport MSTR SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
 
CoreExport COLORREF SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
 Returns true if the object is selected in its schematic view.
 
CoreExport MultiSelectCallbackSvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport void AddXTCObject (XTCObject *pObj, int priority=0, int branchID=-1)
 This method adds an extension object into the pipeline.
 
CoreExport int NumXTCObjects ()
 Returns the number of extension objects maintained by this Object.
 
CoreExport XTCObjectGetXTCObject (int index)
 Returns a pointer to the specified extension object.
 
CoreExport void RemoveXTCObject (int index)
 Removes the extension object as indicated by the index.
 
CoreExport void SetXTCObjectPriority (int index, int priority)
 Sets the priority for the extension object whose index is passed.
 
CoreExport int GetXTCObjectPriority (int index)
 Returns the integer priority number of the extension object whose index is passed.
 
CoreExport void SetXTCObjectBranchID (int index, int branchID)
 Sets the branch ID of the extension object whose index is passed.
 
CoreExport int GetXTCObjectBranchID (int index)
 Returns the integer branch ID of the extension object whose index is passed.
 
CoreExport void MergeAdditionalChannels (Object *from, int branchID)
 This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it).
 
CoreExport void BranchDeleted (int branchID, bool reorderChannels)
 This method has to be called on the CompoundObject so it can delete the XTCObjects for the specified branch.
 
CoreExport void CopyAdditionalChannels (Object *from, bool deleteOld=true, bool bShallowCopy=false)
 This method copies all extension objects from the "from" object into the current object.
 
CoreExport void DeleteAllAdditionalChannels ()
 Implemented by the System.
 
virtual BOOL UseSelectionBrackets ()
 This method allows an object to choose whether or not it will display selection brackets in shaded viewports.
 
virtual BOOL IsManipulator ()
 
CoreExport voidGetInterface (ULONG id) override
 
CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 
virtual void ReduceDisplayCaches ()
 Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it.
 
virtual bool NeedGWCacheRebuilt (GraphicsWindow *gw, Material *ma, int numMat)
 This returns whether the Graphics Cache for this object needs to be rebuilt.
 
virtual void BuildGWCache (GraphicsWindow *gw, Material *ma, int numMat, BOOL threaded)
 This builds the graphics window cached mesh.
 
virtual void StartStackEval ()
 This are called right before and after a modifier is applied to an object.
 
virtual void EndStackEval ()
 
virtual int IsRenderable ()=0
 Indicates whether the object may be rendered.
 
virtual void InitNodeName (MSTR &s)=0
 This is the default name of the node when it is created.
 
virtual int UsesWireColor ()
 This method determines if the object color is used for display.
 
virtual int DoOwnSelectHilite ()
 If an object wants to draw itself in the 3D viewports in its selected state in some custom manner this method should return nonzero.
 
virtual int IntersectRay (TimeValue t, Ray &r, float &at, Point3 &norm)
 This method is called to compute the intersection point and surface normal at this intersection point of the ray passed and the object.
 
virtual BOOL NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm)
 Objects that don't support the IntersectRay() method (such as helper objects) can implement this method to provide a default vector for use with the normal align command in 3ds Max.
 
void LockObject ()
 Implemented by the System.
 
void UnlockObject ()
 Implemented by the System.
 
int IsObjectLocked ()
 Implemented by the System.
 
virtual ObjectState Eval (TimeValue t)=0
 This method is called to evaluate the object and return the result as an ObjectState.
 
void LockChannels (ChannelMask channels)
 Implemented by the System.
 
void UnlockChannels (ChannelMask channels)
 Implemented by the System.
 
ChannelMask GetChannelLocks ()
 Implemented by the System.
 
void SetChannelLocks (ChannelMask channels)
 Implemented by the System.
 
ChannelMask GetChannelLocks (ChannelMask m)
 Implemented by the System.
 
virtual BOOL CanCacheObject ()
 This method determines if this object can have channels cached.
 
virtual void WSStateInvalidate ()
 This is called by a node when the node's world space state has become invalid.
 
virtual BOOL IsWorldSpaceObject ()
 Returns TRUE if the object as a world space object; otherwise FALSE.
 
CoreExport INodeGetWorldSpaceObjectNode ()
 Implemented by the System.
 
virtual BOOL IsParticleSystem ()
 Implemented by the System.
 
CoreExport void CopyChannelLocks (Object *obj, ChannelMask needChannels)
 Implemented by the System.
 
virtual void TopologyChanged ()
 Implemented by the System.
 
virtual int IsDeformable ()
 Indicates whether this object is deformable.
 
virtual int NumPoints ()
 The points of a deformable object are accessed through a virtual array interface.
 
virtual Point3 GetPoint (int i)
 The points of a deformable object are accessed through a virtual array interface.
 
virtual void SetPoint (int i, const Point3 &p)
 The points of a deformable object are accessed through a virtual array interface.
 
virtual BOOL IsPointSelected (int i)
 Returns TRUE if the 'i-th' point is selected; otherwise FALSE.
 
virtual float PointSelection (int i)
 Returns a floating point weighted point selection if the object supports it.
 
virtual BOOL HasWeights ()
 Returns TRUE if the object has weights for its points that can be set; otherwise FALSE.
 
virtual double GetWeight (int i)
 Returns the weight of the specified point of the object.
 
virtual void SetWeight (int i, const double w)
 Sets the weight of the specified point.
 
virtual BOOL PolygonCount (TimeValue t, int &numFaces, int &numVerts)
 Retreives the number of faces and vertices of the polyginal mesh representation of this object.
 
virtual void PointsWereChanged ()
 Informs the object that its points have been deformed, so it can invalidate its cache.
 
virtual CoreExport void Deform (Deformer *defProc, int useSel=0)
 This is the method used to deform the object with a deformer.
 
virtual CoreExport void GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm=NULL, BOOL useSel=FALSE)
 This method computes the bounding box in the objects local coordinates or the optional space defined by tm.
 
virtual int IsMappable ()
 This method lets you know if the ApplyUVWMap() method is available for this object.
 
virtual int NumMapChannels ()
 Returns the maximum number of channels supported by this type of object.
 
virtual int NumMapsUsed ()
 Returns the number of maps currently used by this object.
 
virtual void ApplyUVWMap (int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, int cap, const Matrix3 &tm, int channel=1)
 This method may be called to map the object with UVW mapping coordinates.
 
virtual CoreExport int CanConvertToType (Class_ID obtype)
 Indicates whether the object can be converted to the specified type.
 
virtual CoreExport ObjectConvertToType (TimeValue t, Class_ID obtype)
 This method converts this object to the type specified and returns a pointer it.
 
virtual Class_ID PreferredCollapseType ()
 This method allows objects to specify the class that is the best class to convert to when the user collapses the stack.
 
virtual CoreExport void GetCollapseTypes (Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
 When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented.
 
virtual ObjectCollapseObject ()
 This method is called on the world space cache object when the stack gets collapsed, that lets the pipeline object decide, if it wants to return a different object than itself.
 
virtual DWORD GetSubselState ()
 For objects that have sub selection levels, this method returns the current selection level of the object.
 
virtual void SetSubSelState (DWORD s)
 Implemented by the System.
 
CoreExport void ReadyChannelsForMod (ChannelMask channels)
 Implemented by the System.
 
virtual CoreExport Interval ChannelValidity (TimeValue t, int nchan)
 Retrieve the current validity interval for the nchan channel of the object.
 
virtual CoreExport void SetChannelValidity (int nchan, Interval v)
 Sets the validity interval of the specified channel.
 
virtual CoreExport void InvalidateChannels (ChannelMask channels)
 This method invalidates the intervals for the given channel mask.
 
virtual CoreExport Interval ObjectValidity (TimeValue t)
 This method returns the validity interval of the object as a whole at the specified time.
 
virtual ObjectMakeShallowCopy (ChannelMask channels)
 This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels.
 
virtual CoreExport void ShallowCopy (Object *fromOb, ChannelMask channels)
 This method copies the specified channels from the fromOb to this and copies the validity intervals.
 
virtual CoreExport void FreeChannels (ChannelMask channels)
 This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty).
 
virtual CoreExport void NewAndCopyChannels (ChannelMask channels)
 This method replaces the locked channels with newly allocated copies.
 
virtual CoreExport void MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
 This method allows the object to enlarge its viewport rectangle, if it wants to.
 
CoreExport bool IsBaseClassOwnedChannel (int nchan)
 Implemented by the System.
 
CoreExport void UpdateValidity (int nchan, Interval v)
 When a modifier is applied to an object, it needs to include its own validity interval in the interval of the object.
 
Interval GetNoEvalInterval ()
 
void SetNoEvalInterval (Interval iv)
 
virtual CoreExport void ReduceCaches (TimeValue t)
 This method give the object the chance to reduce its caches.
 
virtual int IsConstObject ()
 This is called to determine if this is a construction object or not.
 
virtual int NumPipeBranches (bool selected=true)
 This method returns the number of pipeline branches combined by the object.
 
virtual ObjectGetPipeBranch (int i, bool selected=true)
 Retrieves sub-object branches from an object that supports branching.
 
virtual INodeGetBranchINode (TimeValue t, INode *node, int i, bool selected=true)
 When an object has sub-object branches, it is likely that the sub-objects are transformed relative to the object.
 
virtual int NumberOfContainedShapes ()
 Returns the number of shapes contained inside this object.
 
virtual ShapeObjectGetContainedShape (TimeValue t, int index)
 This method returns the ShapeObject specified by the index passed at the time specified.
 
virtual void GetContainedShapeMatrix (TimeValue t, int index, Matrix3 &mat)
 Returns the matrix associated with the shape whose index is passed.
 
virtual BitArray ContainedShapeSelectionArray ()
 This is used by the lofter.
 
virtual BOOL IsShapeObject ()
 Returns the number of shapes contained inside this object.
 
- Public Member Functions inherited from BaseObject
virtual CoreExport unsigned long GetObjectDisplayRequirement () const
 
virtual CoreExport bool PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
 
virtual CoreExport bool UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport bool UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArrayGetRenderItems () const
 
virtual CoreExport voidGetInterface (ULONG id) override
 
virtual CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 
CoreExport BaseObject ()
 
virtual CoreExport ~BaseObject ()
 
virtual BOOL HasViewDependentBoundingBox ()
 This method return true if GetWorldBoundBox returns different boxes for different viewports.
 
virtual int HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt)
 This method is called to determine if the specified screen point intersects the item.
 
virtual void SetExtendedDisplay (int flags)
 This method is used for storing mode-dependent display attributes.
 
virtual int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
 This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).
 
virtual void Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt)
 Checks the point passed for a snap and updates the SnapInfo structure.
 
virtual void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
 This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).
 
virtual void GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
 This is the object space bounding box, the box in the object's local coordinates.
 
virtual CreateMouseCallBackGetCreateMouseCallBack ()=0
 This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
 
 __declspec (deprecated) virtual const MCHAR *GetObjectName() MAX_SEALED
 
virtual const MCHARGetObjectName (bool localized) const
 
virtual CoreExport BOOL OKToChangeTopology (MSTR &modName)
 Implemented by the System.
 
virtual BOOL ChangeTopology ()
 This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE.
 
virtual void ForceNotify (Interval &i)
 Notifies dependents of a change.
 
virtual IParamArrayGetParamBlock ()
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
 
virtual IParamBlock2GetParamBlock (int i) override
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
 
virtual int GetParamBlockIndex (int id)
 If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block.
 
virtual void Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by moving its selected sub-object components.
 
virtual void Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by rotating its selected sub-object components.
 
virtual void Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by scaling its selected sub-object components.
 
virtual void TransformStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect.
 
virtual void TransformHoldingStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect.
 
virtual void TransformHoldingFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted.
 
virtual void TransformFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted.
 
virtual void TransformCancel (TimeValue t)
 This method is called when the transform operation is canceled by a right-click and the undo has been canceled.
 
virtual int HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc)
 This method is used in modifier gizmo hit testing.
 
virtual int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags, ModContext *mc)
 When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM.
 
virtual void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc)
 This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo).
 
virtual void CloneSelSubComponents (TimeValue t)
 This method is called to make a copy of the selected sub-object components of the item.
 
virtual void AcceptCloneSelSubComponents (TimeValue t)
 This method is called when the user mouses up after shift-cloning a sub-object selection.
 
virtual void SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
 This method is called to change the selection state of the component identified by hitRec.
 
virtual void ClearSelection (int selLevel)
 This method is called to clear the selection for the given sub-object level.
 
virtual void SelectAll (int selLevel)
 This method is called to select every element of the given sub-object level.
 
virtual void InvertSelection (int selLevel)
 This method is called to invert the specified sub-object level.
 
virtual int SubObjectIndex (HitRecord *hitRec)
 Returns the index of the sub-object element identified by the HitRecord hitRec.
 
virtual void ActivateSubobjSel (int level, XFormModes &modes)
 When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in.
 
virtual BOOL SupportsNamedSubSels ()
 An object that supports sub-object selection can choose to support named sub object selection sets.
 
virtual void ActivateSubSelSet (MSTR &setName)
 When the user chooses a name from the drop down list this method is called.
 
virtual void NewSetFromCurSel (MSTR &setName)
 If the user types a new name into the named selection set drop down then this method is called.
 
virtual void RemoveSubSelSet (MSTR &setName)
 If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called.
 
virtual void SetupNamedSelDropDown ()
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual int NumNamedSelSets ()
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual MSTR GetNamedSelSetName (int i)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void SetNamedSelSetName (int i, MSTR &newName)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
 
virtual void GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
 
virtual void NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
 This method is called before a modifier or object is collapsed.
 
virtual void NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
 This method is called after a modifier or object is collapsed.
 
virtual int NumSubObjTypes ()
 Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType().
 
virtual ISubObjTypeGetSubObjType (int i)
 Returns a pointer to the sub-object type for the sub-object whose index is passed.
 
virtual CoreExport int GetSubObjectLevel ()
 This method returns an integer which indicates the current sub-object level of the modifier or base object.
 
virtual void SetGenUVW (BOOL sw)
 This method is called to change the state of its Generate UVW boolean.
 
virtual void SetGenUVW (int mapChannel, BOOL sw)
 This method is called to change the state of its Generate UVW boolean for the specified mapping channel.
 
virtual void ShowEndResultChanged (BOOL showEndResult)
 This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled).
 
- Public Member Functions inherited from ReferenceTarget
CoreExport void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class.
 
CoreExport SClass_ID SuperClassID () override
 Retrieves a constant representing the type of the plugin.
 
BOOL IsRefTarget () override
 Checks if this is a ReferenceTarget.
 
CoreExport RefResult TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
 Tests for a cyclical reference.
 
CoreExport BOOL HasDependents ()
 Checks if a ReferenceTarget has references.
 
CoreExport BOOL HasRealDependents ()
 Checks if this has Real (Strong) Dependents.
 
void BeginDependencyTest ()
 Starts Dependency Test.
 
BOOL EndDependencyTest ()
 Ends Dependency Test.
 
virtual void RefAdded (RefMakerHandle rm)
 Called after a reference is made to a target.
 
virtual void RefAddedUndoRedo (RefMakerHandle rm)
 Called after a reference is made to a target because of undo or redo.
 
 __declspec (deprecated) virtual void RefDeleted() final
 
virtual void RefDeleted (ReferenceMaker *oldOwner)
 Called after a reference to this is deleted.
 
 __declspec (deprecated) virtual void RefDeletedUndoRedo() final
 
virtual void RefDeletedUndoRedo (RefMakerHandle oldOwner)
 Called after a reference to this is deleted because of undo or redo.
 
CoreExport RefResult DeleteAllRefsToMe () override
 Deletes all references to this ReferenceTarget.
 
CoreExport RefResult TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
 Transfers all the references from oldTarget to this.
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network.
 
virtual CoreExport RefTargetHandle Clone (RemapDir &remap)
 This method is used by 3ds Max to clone an object.
 
virtual CoreExport void BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
 This method copies base class data from an object to its clone.
 
CoreExport RefResult NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=nullptr, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS) override
 Notify all dependent RefMakers concerned with the message.
 
void FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
 This sends the REFMSG_FLAGDEPENDENTS message up the pipeline.
 
virtual void NotifyForeground (TimeValue t)
 This method is called to flag dependents into the FG.
 
virtual void NotifyTarget (int message, ReferenceMaker *hMaker)
 Sends messages to ReferenceTargets.
 
CoreExport voidGetInterface (ULONG id) override
 Inherited from Animatable.
 
CoreExport ReferenceTarget ()
 Constructor.
 
virtual CoreExport RefResult AutoDelete ()
 Deletes the object when it has no more real dependents.
 
CoreExport RefResult MaybeAutoDelete ()
 Deletes the object when it has no more real dependents.
 
- Public Member Functions inherited from ReferenceMaker
void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class.
 
CoreExport SClass_ID SuperClassID () override
 Retrieves a constant representing the type of the plugin.
 
CoreExport RefResult ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
 Used when cloning reference makers.
 
CoreExport RefResult DeleteAllRefsFromMe ()
 Deletes all references from this ReferenceMaker.
 
CoreExport RefResult DeleteAllRefs ()
 Deletes all references both to and from this item.
 
CoreExport RefResult DeleteReference (int i)
 Deletes the specified reference.
 
virtual BOOL CanTransferReference (int i)
 Tells whether this reference can be transfered.
 
CoreExport ReferenceSaveManagerGetReferenceSaveManager ()
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual CoreExport IOResult Save (ISave *isave)
 Called for saving data.
 
virtual CoreExport IOResult Save (ISave *isave, ChannelMask)
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual CoreExport IOResult Load (ILoad *iload)
 Called for loading data.
 
virtual CoreExport IOResult Load (ILoad *iload, ChannelMask)
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual int RemapRefOnLoad (int iref)
 Used to load old files with references.
 
virtual CoreExport void RescaleWorldUnits (float f)
 Rescale size of all world units in reference hierarchy.
 
CoreExport void EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags) override
 Enumerate auxiliary files (e.g. bitmaps)
 
virtual CoreExport void SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
 The default save enumeration.
 
virtual CoreExport bool SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
 Used to specify reference slot remapping during scene file save.
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network.
 
CoreExport bool EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
 This method provides a general purpose reference enumerator.
 
CoreExport int FindRef (RefTargetHandle rtarg)
 Get the index of the ReferenceTarget.
 
BOOL IsRefMaker () override
 Tells whether it is a ReferenceMaker.
 
virtual BOOL IsRealDependency (ReferenceTarget *rtarg)
 Returns whether this is a "real" (strong) dependency or not.
 
virtual BOOL ShouldPersistWeakRef (RefTargetHandle rtarg)
 Specifies whether a weak reference is to be persisted on a partial load or save.
 
CoreExport ReferenceMaker ()
 Constructor.
 
CoreExport void DeleteMe ()
 Deletes an instance of this class.
 
virtual CoreExport int NumRefs ()
 Returns the total number of references this ReferenceMaker can hold.
 
virtual CoreExport RefTargetHandle GetReference (int i)
 Returns the 'i-th' reference.
 
- Public Member Functions inherited from Animatable
virtual void FreeCaches ()
 
virtual int NumChildren ()
 
virtual AnimatableChildAnim (int i)
 
virtual CoreExport MSTR NodeName ()
 
virtual void EditTrack ()
 
virtual CoreExport BOOL SubAnimSetKeyBufferPresent (int subNum)
 returns true if the sub-anim has a "Set Key" buffer present
 
virtual BOOL SetKeyBufferPresent ()
 returns true if there is a "Set Key" buffer present
 
virtual CoreExport void SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
 Commit any "Set Key" buffers on the given sub-anim.
 
virtual void CommitSetKeyBuffer (TimeValue t)
 Commit any "Set Key" buffers.
 
virtual CoreExport void SubAnimRevertSetKeyBuffer (int subNum)
 Revert any "Set Key" buffers on the given sub-anim.
 
virtual void RevertSetKeyBuffer ()
 Revert any "Set Key" buffers.
 
virtual LRESULT CALLBACK TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
 This function is obsolete.
 
virtual BOOL IsRefMaker ()
 Tells whether it is a ReferenceMaker.
 
virtual bool IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
 Returns true if the passed description is being used.
 
virtual bool GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
 This method is called to access the object specified name to use for the Maxscript macrorecorder.
 
CoreExport Animatable ()
 Constructor.
 
virtual CoreExport void DeleteThis ()
 Deletes an instance of this class.
 
MSTR ClassName (bool localized=true) const
 Returns the name of the plugin class.
 
virtual 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 voidGetProperty (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 AnimPropertyFindProperty (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 AppDataChunkGetAppDataChunk (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 AnimatableSubAnim (int i)
 
 __declspec (deprecated) virtual MSTR SubAnimName(int i) MAX_SEALED
 
virtual CoreExport MSTR SubAnimName (int i, bool localized)
 
virtual BOOL CanDeleteSubAnim (int i)
 
virtual void DeleteSubAnim (int i)
 
virtual DWORD GetSubAnimCurveColor (int subNum)
 
virtual int SubNumToRefNum (int subNum)
 
virtual BOOL CanCopyAnim ()
 
CoreExport int HasSubElements (int type=0)
 
virtual int GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 The values max and min should be initialized before calling this function.
 
virtual ParamDimensionGetParamDimension (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 TrackClipObjectCopyTrack (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 TrackClipObjectCopySubTrack (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 NoteTrackGetNoteTrack (int i)
 
virtual void FreeAllBitmaps ()
 
virtual void GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
 
virtual BOOL IsSubClassOf (Class_ID classID)
 returns true if the animatable has sub-classed off the given class
 
virtual CoreExport void MouseCycleCompleted (TimeValue t)
 
virtual CoreExport void MouseCycleStarted (TimeValue t)
 
virtual int NumParamBlocks ()
 
virtual IParamBlock2GetParamBlockByID (short id)
 
CoreExport bool SvSaveData (ISave *isave, USHORT id)
 
CoreExport bool SvLoadData (ILoad *iLoad)
 
CoreExport DWORD SvGetRefIndex ()
 
CoreExport void SvSetRefIndex (DWORD i)
 
CoreExport bool SvDeleteRefIndex ()
 
CoreExport SvGraphNodeReference SvStdTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
 
virtual CoreExport bool SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
 
virtual CoreExport bool SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
 
virtual CoreExport bool SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
 Called when the user deletes this object in the schematic view...
 
virtual CoreExport bool SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport COLORREF SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
 
virtual CoreExport bool SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
 
virtual CoreExport bool SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"...
 
virtual CoreExport bool SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns true if this object can respond to the SvDetachRel(...) method...
 
virtual CoreExport bool SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Detach this relationship.
 
virtual CoreExport bool SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Called when this relationship is double-clicked in the schematic view...
 
CoreExport ICustAttribContainerGetCustAttribContainer ()
 This method returns a pointer to the custom attributes container interface class.
 
CoreExport void AllocCustAttribContainer ()
 This method allocates space for a custom attributes container.
 
CoreExport void DeleteCustAttribContainer ()
 This method deletes space used by a custom attributes container.
 
void SetAFlag (DWORD mask)
 
void ClearAFlag (DWORD mask)
 Clears one or more bits in the Animatable flags.
 
bool TestAFlag (DWORD mask) const
 Tests one or more bits in the Animatable flags.
 
void SetAFlagEx (DWORD mask)
 Sets one or more bits in the Animatable extended flags.
 
void ClearAFlagEx (DWORD mask)
 Clears one or more bits in the Animatable extended flags.
 
bool TestAFlagEx (DWORD mask) const
 Tests one or more bits in the Animatable extended flags.
 
CoreExport bool TestFlagBit (int index)
 Tests the specified flag bit.
 
CoreExport void SetFlagBit (int index, bool newValue=true)
 Sets the specified flag bit.
 
CoreExport void ClearFlagBit (int index)
 Clears the specified flag bit.
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
 
virtual UtilExport BaseInterfaceGetInterface (Interface_ID id)
 
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 BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDescByID (Interface_ID id)
 
virtual Interface_ID GetID ()
 
- Public Member Functions inherited from FPInterface
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDesc ()=0
 
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 ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
 
UtilExport BaseInterfaceGetInterface (Interface_ID id) override
 
virtual UtilExport Interface_ID GetID ()
 
virtual LifetimeType LifetimeControl ()
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 

Static Public Member Functions

static bool Is_IXRefObject8 (Animatable &animatable)
 Allows to determine whethe a scene entity implements this interface.
 
static IXRefObject8GetInterface (InterfaceServer &is)
 Retrieves the IXRefObject8 interface from a scene entity.
 
- 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 AnimatableGetAnimByHandle (AnimHandle handle)
 Get an Animatable object from its unique handle.
 
static CoreExport AnimHandle GetNextHandle ()
 Get the unique handle for the next Animatable object to be created.
 
static CoreExport void EnumerateAllAnimatables (EnumAnimList &enumProcObject)
 Enumerator to enumerate across all animatables.
 
static CoreExport bool RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport void ClearAFlagInAllAnimatables (DWORD mask)
 Clears one or more bits in the Animatable flags in all Animatables.
 
static CoreExport void ClearAFlagExInAllAnimatables (DWORD mask)
 Clears one or more bits in the Animatable extended flags in all Animatables.
 
static CoreExport int RequestFlagBit ()
 Requests an unique flag bit index.
 
static CoreExport void ReleaseFlagBit (int index)
 Releases the flag bit index.
 
static CoreExport void ClearFlagBitInAllAnimatables (int index)
 Clears the specified flag bit in all Animatables.
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_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

static FPInterfaceDesc mFPInterfaceDesc
 
- Static Public Attributes inherited from Animatable
static const AnimHandle kInvalidAnimHandle = 0
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 

Additional Inherited Members

- 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)
 
FPMixinInterfaceoperator= (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 BaseObject
MaxSDK::Graphics::RenderItemHandleArray mRenderItemHandles
 
- Protected Attributes inherited from Animatable
DWORD aflag
 
AnimPropertyList aprops
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 

Detailed Description

Class representing Xref objects.

This interface groups functionality specific to xref objects. In order to access functionality common to all xref scene entities, use the IXRefItem interface. An xref object acts as a wrapper around the xrefed object (also referred to as the "source object"). For example, requests for evaluating the xref object (Eval) and finding its base object (FindBaseObject) are passed to the source object, as are requests for interfaces. Client or plugin code working with objects should not be required to write xref object specific code, unless the desired functionality is xref specific.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kfpGetActiveFileName 
kfpGetActiveObjName 
kfpGetActiveRecord 
kfpGetSourceObject 
239 {
244 };
@ kfpGetActiveFileName
Definition: iXrefObj.h:240
@ kfpGetSourceObject
Definition: iXrefObj.h:243
@ kfpGetActiveRecord
Definition: iXrefObj.h:242
@ kfpGetActiveObjName
Definition: iXrefObj.h:241

Member Function Documentation

◆ GetActiveFile()

virtual const MaxSDK::AssetManagement::AssetUser & GetActiveFile ( ) const
pure virtual

Retrieves the active source file

The file currently used by the xref object could be the one where the source object comes from or the one where the proxy object comes from. Which file is currently used depends on the proxy settings of the xref object

Returns
- The file asset currently used by the xref object.
See also
IXRefProxy, IXRefItem

◆ GetActiveObjName()

virtual const MCHAR * GetActiveObjName ( ) const
pure virtual

Retrieves the active source item name.

The object name currently used by the xref object could be the source or the proxy object name. Which object name currently used depends on the proxy settings of the xref object.

Returns
- Pointer to the name of the object currently xrefed or NULL if the name is not specified.
See also
IXRefProxy, IXRefItem

◆ GetActiveRecord()

virtual IObjXRefRecord * GetActiveRecord ( ) const
pure virtual

Retrieves the active xref record this xref object belongs to.

When the proxy object assigned to this xref object is active, this method returns the xref record that owns the xref proxy. Otherwise it returns the xref record that owns the original xref item.

Returns
The active xref record this xref object belongs to. A return value of NULL, indicates that the xref object is not part of an xref record yet.

◆ GetSourceObject()

virtual Object * GetSourceObject ( bool  resolveNested = false,
Tab< Modifier * > *  modifiers = NULL 
) const
pure virtual

Retrieves the actual source object behind the XRef.

Parameters
[in]resolveNested- When set to true, the method will recursively resolve any nested xref objects, guaranteeing that the one being returned is NOT an xref object. When set to false, the source object is returned without attempting to resolve nesting.
[in,out]modifiers- a pointer to a Tab<Modifier*> or NULL. If not NULL, the modifiers in the source object will be placed in the tab.
Returns
The source object, or NULL if the xref is unresolved.

◆ Is_IXRefObject8()

bool Is_IXRefObject8 ( Animatable animatable)
inlinestatic

Allows to determine whethe a scene entity implements this interface.

Parameters
[in]animatable- Reference to scene entity
Returns
- true if the scene entity implements the IXRefObject8 interface, false otherwise
262 {
263 return ((animatable.SuperClassID() == SYSTEM_CLASS_ID)
264 && (animatable.ClassID() == XREFOBJ_CLASS_ID));
265}
virtual CoreExport SClass_ID SuperClassID()=0
Retrieves a constant representing the type of the plugin.
virtual CoreExport Class_ID ClassID()
Retrieves a constant that uniquely identifies the plugin class.
#define XREFOBJ_CLASS_ID
XRef object class ID.
Definition: plugapi.h:622
#define SYSTEM_CLASS_ID
System plug-in super-class ID.
Definition: plugapi.h:447

◆ GetInterface() [1/2]

static IXRefObject8 * GetInterface ( InterfaceServer is)
inlinestatic

Retrieves the IXRefObject8 interface from a scene entity.

Parameters
[in]is- Reference to scene entity
Returns
- Pointer to the IXRefObject8 interface of the scene entity or NULL if it's not an xref object
232 {
233 return static_cast<IXRefObject8*>(is.GetInterface(IID_XREF_OBJECT8));
234 };
Class representing Xref objects.
Definition: iXrefObj.h:182
virtual UtilExport BaseInterface * GetInterface(Interface_ID id)
#define IID_XREF_OBJECT8
Id for IXRefObject8 interface.
Definition: iXrefObj.h:169

◆ GetID()

virtual Interface_ID GetID ( )
inlinevirtual

Gets the interface ID.

Reimplemented from FPMixinInterface.

237{ return IID_XREF_OBJECT8; }

◆ RO_PROP_FN() [1/3]

RO_PROP_FN ( kfpGetActiveFileName  ,
FPGetActiveFileName  ,
TYPE_FILENAME   
)

◆ RO_PROP_FN() [2/3]

RO_PROP_FN ( kfpGetActiveObjName  ,
GetActiveObjName  ,
TYPE_STRING   
)

◆ RO_PROP_FN() [3/3]

RO_PROP_FN ( kfpGetActiveRecord  ,
GetActiveRecord  ,
TYPE_INTERFACE   
)

◆ FN_2()

FN_2 ( kfpGetSourceObject  ,
TYPE_REFTARG  ,
FPGetSourceObject  ,
TYPE_bool  ,
TYPE_REFTARG_TAB_BR   
)

◆ GetDesc()

virtual FPInterfaceDesc * GetDesc ( )
inlinevirtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

254{ return &mFPInterfaceDesc; }
static FPInterfaceDesc mFPInterfaceDesc
Definition: iXrefObj.h:255

◆ GetInterface() [2/2]

virtual BaseInterface * GetInterface ( Interface_ID  id)
inlinevirtual
Remarks
Returns a pointer to the interface whose ID is specified.
Parameters:
Interface_ID id

The ID of the interface to return.
Default Implementation:
{ return NULL; }

Reimplemented from FPMixinInterface.

595{ if (id == FPMIXININTERFACE_ID) return this; else return FPInterface::GetInterface(id); }
virtual BaseInterface * GetInterface(Interface_ID id)
Definition: ifnpub.h:142
#define FPMIXININTERFACE_ID
Definition: ifnpub.h:61

Member Data Documentation

◆ mFPInterfaceDesc

FPInterfaceDesc mFPInterfaceDesc
static