MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState Class Reference

---

Detailed Description

Extends ExplorerCustomizationState to include configuration data specific to Scene Explorers.

Inheritance diagram for MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState:

List of all members.

Public Member Functions
	SceneExplorerCustomizationState ()
	Default constructor.
	SceneExplorerCustomizationState (int aColumnCount)
	Construct with a given number of columns.
override bool	LoadProperties (Dictionary< String, String > aPropertySet)
	Loads the values from the given dictionary into this customization object.
override Dictionary< String, String >	SaveProperties ()
	Creates a dictionary mapping keynames to properties for the properties held by this State object.
Protected Types
enum	SceneExplorerPropertyKeys {   DisplayInfluences, DisplayDependants, SelectInfluences, SelectDependants,   FindStyleOption, FindCaseSensitive, SyncSelection, DisplayToolbarState,   ContainerToolbarState, FilterSelectionSetEnabled, ToolBarLayout, DynamicsToolbarState,   NonDynamics }
	Key constants for properties specific to the Scene Explorer. More...
Properties
bool	DisplayInfluences [get, set]
	Determines if the selected nodes' influences are highlighted.
bool	DisplayDependants [get, set]
	Determines if the selected nodes' dependants are highlighted.
bool	SelectInfluences [get, set]
	Determines if the selected nodes' influences are automatically added to the selection.
bool	SelectDependants [get, set]
	Determines if the selected nodes' dependants are automatically added to the selection.
FindStyle	FindStyleOption [get, set]
	Determines the quick-find search style: strict, regex or wildcard.
bool	FindCaseSensitive [get, set]
	Determines if quick-find searching is case sensitive.
bool	SyncSelection [get, set]
	Determines if the node selection is automatically kept in sync with the scene.
bool	FilterSelectionSetEnabled [get, set]
	Is FilterSelectionSetEnabled enabled in current scene explorer.
FormCustomizationState	TopLevelControlState [get, set]
bool	ShowFrozen [get, set]
	<exclude>
bool	ShowHidden [get, set]
	<exclude>

---

Member Enumeration Documentation

enum MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::SceneExplorerPropertyKeys [protected]

Key constants for properties specific to the Scene Explorer.

Enumerator:

DisplayInfluences
DisplayDependants
SelectInfluences
SelectDependants
FindStyleOption
FindCaseSensitive
SyncSelection
DisplayToolbarState
ContainerToolbarState
FilterSelectionSetEnabled
ToolBarLayout
DynamicsToolbarState
NonDynamics

---

Constructor & Destructor Documentation

MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::SceneExplorerCustomizationState

(

)

[inline]

Default constructor.

MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::SceneExplorerCustomizationState

(

int

aColumnCount

)

[inline]

Construct with a given number of columns.

Parameters:

aColumnCount

Number of columns in the explorer.

---

Member Function Documentation

override bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::LoadProperties

(

Dictionary< String, String >

aPropertySet

)

[inline, virtual]

Loads the values from the given dictionary into this customization object.

Extends the base method to add support for properties specific to the Scene Explorer.

Parameters:

aPropertySet

A dictionary mapping keynames to properties.

Reimplemented from MaxCustomControls::ExplorerCustomizationState.

override Dictionary<String, String> MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::SaveProperties

(

)

[inline, virtual]

Creates a dictionary mapping keynames to properties for the properties held by this State object.

Extends the base implementation to add support for properties specific to Scene Explorers.

Returns:

A dictionary mapping keynames to property values.

Reimplemented from MaxCustomControls::ExplorerCustomizationState.

---

Property Documentation

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::DisplayInfluences [get, set]

Determines if the selected nodes' influences are highlighted.

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::DisplayDependants [get, set]

Determines if the selected nodes' dependants are highlighted.

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::SelectInfluences [get, set]

Determines if the selected nodes' influences are automatically added to the selection.

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::SelectDependants [get, set]

Determines if the selected nodes' dependants are automatically added to the selection.

FindStyle MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::FindStyleOption [get, set]

Determines the quick-find search style: strict, regex or wildcard.

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::FindCaseSensitive [get, set]

Determines if quick-find searching is case sensitive.

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::SyncSelection [get, set]

Determines if the node selection is automatically kept in sync with the scene.

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::FilterSelectionSetEnabled [get, set]

Is FilterSelectionSetEnabled enabled in current scene explorer.

FormCustomizationState MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::TopLevelControlState [get, set]

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::ShowFrozen [get, set]

<exclude>

This property determines the state of the show-frozen filter.

bool MaxCustomControls::SceneExplorerControls::SceneExplorerCustomizationState::ShowHidden [get, set]

<exclude>

This property determines the state of the show-hidden filter.