Public Member Functions

CustAttrib Class Reference

This reference page is linked to from the following overview topics: Custom Attributes.


Search for all occurrences

Detailed Description

See also:
Class ICustAttribContainer, Class ReferenceTarget, Class ParamDlg, Class Animatable

Description:
This class is available in release 4.0 and later only.

This class represents the Custom Attributes.

A sample on how to use this class is located in /MAXSDK/SAMPLES/HOWTO/CUSTATTRIBUTIL

#include <custattrib.h>

Inheritance diagram for CustAttrib:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual SClass_ID  SuperClassID ()
  Retrieves a constant representing the type of the plugin.
virtual const MCHAR *  GetName ()
virtual ParamDlg CreateParamDlg (HWND hwMtlEdit, IMtlParams *imp)
virtual bool  CheckCopyAttribTo (ICustAttribContainer *to)
virtual SvGraphNodeReference  SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)

Member Function Documentation

virtual SClass_ID SuperClassID ( ) [inline, virtual]

Retrieves a constant representing the type of the plugin.

Returns:
A super class id that uniquely identifies the type (category) of the plugin. Note that several plugin classes can be of the same type, thus return the same super class id. Plugins are uniquely identified by their class ids. List of Super Class IDs.
See also:
SClass_ID

Reimplemented from ReferenceTarget.

Reimplemented in MSCustAttrib.

{ return CUST_ATTRIB_CLASS_ID; }
virtual const MCHAR* GetName ( ) [inline, virtual]
Remarks:
A CustAttrib plugin can implement this method in order to provide the name that gets displayed in the TrackView.
Default Implementation:
{ return "Custom Attribute";}

Reimplemented in MSCustAttrib.

{ return _M("Custom Attribute");}
virtual ParamDlg* CreateParamDlg ( HWND  hwMtlEdit,
IMtlParams imp 
) [inline, virtual]
Remarks:
This method gets called when the material or texture is to be displayed in the material editor parameters area. The plug-in should allocate a new instance of a class derived from ParamDlg to manage the user interface.
Parameters:
HWND hwMtlEdit

The window handle of the materials editor.

IMtlParams *imp

The interface pointer for calling methods in 3ds Max.
Returns:
A pointer to the created instance of a class derived from ParamDlg.
Default Implementation:
{return NULL;}

Reimplemented in MSCustAttrib.

{return NULL;}
virtual bool CheckCopyAttribTo ( ICustAttribContainer to ) [inline, virtual]
Remarks:
This method will check if it possible to copy the current custom attributes to the specified custom attributes container.
Parameters:
ICustAttribContainer *to

A pointer to the custom attributes container you wish to check for possible reception of the custom attributes..
Returns:
TRUE if it is possible to copy, otherwise FALSE.
Default Implementation:
{ return true; }
{ return true; }
virtual SvGraphNodeReference SvTraverseAnimGraph ( IGraphObjectManager gom,
Animatable owner,
int  id,
DWORD  flags 
) [inline, virtual]
Remarks:
This method is available in release 3.0 and later only.

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

See Class IGraphObjectManager.
Parameters:
gom Points to the schematic view window manager.
owner The owning animatable.
id This is usually the sub-anim number (but can actually be any value the developer chooses).
flags See List of Schematic %View AddAnimatable Flags.
Returns:
A SvGraphNodeReference object.

Reimplemented from Animatable.

    {
        return SvStdTraverseAnimGraph(gom, owner, id, flags); 
    }

CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib
CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib CustAttrib