MaxCustomControls::ICustomizationState Interface Reference

---

Detailed Description

Interface definition for CustomizationState.

Inheritance diagram for MaxCustomControls::ICustomizationState:

List of all members.

Public Member Functions
bool	LoadProperties (Dictionary< String, String > aPropertySet)
	Given a dictionary mapping keyNames to properties, loads the properties into this CustomizationState object.
Dictionary< String, String >	SaveProperties ()
	Create a dictionary mapping keyNames to properties, saves the properties into this dictionary.
bool	AddChild (ICustomizationState stateObject)
	Add a child customizationState object to the current object.
ICustomizationState	GetChildByIndex (int index)
	Get the index-th child state object.
ICustomizationState	GetChildByName (String name)
	Get the child state object by its state name.
bool	RemoveChildByIndex (int index)
	Remove the index-th child state object.
bool	RemoveChildByName (String name)
	Remove the child state object by its state name.
Properties
int	ChildrenCount [get]
	Get the count of child states.
String	StateName [get, set]
	Get or set the name of the current ICustomizationState instance.
ICustomizationState	ParentState [get, set]
	Get or set the parent customizationState of current one.

---

Member Function Documentation

bool MaxCustomControls::ICustomizationState::LoadProperties

(

Dictionary< String, String >

aPropertySet

)

Given a dictionary mapping keyNames to properties, loads the properties into this CustomizationState object.

It is the client's responsibility to serialize and deserialize custom properties, since the Value type in the Dictionary is a String.

Parameters:

aPropertySet

A dictionary mapping keyNames to properties.

Returns:

Return true if loading successfully; otherwise false.

Implemented in MaxCustomControls::BaseCustomizationState, MaxCustomControls::BaseMaterialControls::RichMaterialExplorerControlState, MaxCustomControls::ExplorerCustomizationState, MaxCustomControls::FormCustomizationState, MaxCustomControls::MaterialExplorerControls::MaterialExplorerCustomizationState, MaxCustomControls::MaterialExplorerControls::SceneMaterialExplorerState, MaxCustomControls::MaterialExplorerControls::SelectedMaterialExplorerState, and MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState.

Dictionary<String, String> MaxCustomControls::ICustomizationState::SaveProperties

(

)

Create a dictionary mapping keyNames to properties, saves the properties into this dictionary.

It is the client's responsibility to serialize and deserialize custom properties, since the Value type in the Dictionary is a String.

Returns:

Return a dictionary mapping keyNames to properties. If failed, return null.

Implemented in MaxCustomControls::BaseCustomizationState, MaxCustomControls::BaseMaterialControls::RichMaterialExplorerControlState, MaxCustomControls::ExplorerCustomizationState, MaxCustomControls::FormCustomizationState, MaxCustomControls::MaterialExplorerControls::MaterialExplorerCustomizationState, MaxCustomControls::MaterialExplorerControls::SceneMaterialExplorerState, MaxCustomControls::MaterialExplorerControls::SelectedMaterialExplorerState, and MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState.

bool MaxCustomControls::ICustomizationState::AddChild

(

ICustomizationState

stateObject

)

Add a child customizationState object to the current object.

Parameters:

stateObject

The child state object

Returns:

Return true if successful, false otherwise.

Implemented in MaxCustomControls::BaseCustomizationState.

ICustomizationState MaxCustomControls::ICustomizationState::GetChildByIndex

(

int

index

)

Get the index-th child state object.

Parameters:

index

the child state's index

Returns:

If the index is valid, return the child state. null otherwise.

Implemented in MaxCustomControls::BaseCustomizationState.

ICustomizationState MaxCustomControls::ICustomizationState::GetChildByName

(

String

name

)

Get the child state object by its state name.

Client should use this method to get the correct child state object.

Parameters:

name	the name of the child state object.

Returns:

If the name is valid, return the child state. null otherwise.

Implemented in MaxCustomControls::BaseCustomizationState.

bool MaxCustomControls::ICustomizationState::RemoveChildByIndex

(

int

index

)

Remove the index-th child state object.

Parameters:

index

the index of the child state object.

Returns:

Return true if successful, false otherwise.

Implemented in MaxCustomControls::BaseCustomizationState.

bool MaxCustomControls::ICustomizationState::RemoveChildByName

(

String

name

)

Remove the child state object by its state name.

Parameters:

name	the name of the child state object to be removed.

Returns:

Return true if successful, false otherwise.

Implemented in MaxCustomControls::BaseCustomizationState.

---

Property Documentation

int MaxCustomControls::ICustomizationState::ChildrenCount [get]

Get the count of child states.

Implemented in MaxCustomControls::BaseCustomizationState.

String MaxCustomControls::ICustomizationState::StateName [get, set]

Get or set the name of the current ICustomizationState instance.

The stateName of a CustomizationState object must be unique among all its siblings.

Implemented in MaxCustomControls::BaseCustomizationState.

ICustomizationState MaxCustomControls::ICustomizationState::ParentState [get, set]

Get or set the parent customizationState of current one.

Implemented in MaxCustomControls::BaseCustomizationState.