Class ICustAttribContainer

3DS Max Plug-In SDK

Class ICustAttribContainer

See Also: Class CustAttrib , Class RemapDir , Class ReferenceTarget

class ICustAttribContainer : public ReferenceTarget

Description:

This class is available in release 4.0 and later only.

This class represents the interface class to a custom attributes container.

Methods:

public:

Prototype:

virtual int GetNumCustAttribs()=0;

Remarks:

This method returns the number of custom attributes.

Prototype:

virtual CustAttrib *GetCustAttrib(int i)=0;

Remarks:

This method allows you to retrieve the custom attribute by its specified index.

Parameters:

int i

The index of the custom attribute you with to obtain.

Prototype:

virtual void AppendCustAttrib(CustAttrib *attribute)=0;

Remarks:

This method allows you to append a custom attribute.

Parameters:

CustAttrib *attribute

A pointer to the custom attribute you wish to add.

Prototype:

virtual void SetCustAttrib(int i, CustAttrib *attribute)=0;

Remarks:

This method allows you to set the custom attribute at the specified index.

Parameters:

int i

The index for which to set the custom attribute.

CustAttrib *attribute

A pointer to the custom attribute you wish to set.

Prototype:

virtual void InsertCustAttrib(int i, CustAttrib *attribute)=0;

Remarks:

This method allows you to insert a custom attribute at the specified index.

Parameters:

int i

The index at which to insert the custom attribute.

CustAttrib *attribute

A pointer to the custom attribute you wish to insert.

 

Return Value:

 

Prototype:

virtual void RemoveCustAttrib(int i)=0;

Remarks:

This method allows you to remove a custom attribute.

Parameters:

int i

The index of the custom attribute to remove.

Prototype:

virtual ParamDlg* CreateParamDlg(HWND hwMtlEdit, IMtlParams *imp)=0;

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.

Return Value:

A pointer to the created instance of a class derived from ParamDlg.

Prototype:

virtual void CopyParametersFrom(ReferenceMaker *from, RemapDir &remap)=0;

Remarks:

This method will copy the parameters from a specified reference maker.

Parameters:

ReferenceMaker *from

A pointer to the reference maker to copy the parameters from.

RemapDir &remap

This class is used for remapping references during a Clone. See Class RemapDir.

Prototype:

virtual Animatable *GetOwner()=0;

Remarks:

This method returns a pointer to the owner of the custom attributes.

Prototype:

virtual void DeleteThis()=0;

Remarks:

Self deletion.