MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl Class Reference

---

Detailed Description

Specializes the ExplorerControl for the Scene Explorer.

This explores the scene node data set.

Inheritance diagram for MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl:

List of all members.

Classes
class	SelectionSetFilterItem
Public Member Functions
	RichSceneExplorerControl ()
	Default constructor.
	RichSceneExplorerControl (String aName, ExplorerFramework.DataFacade aDataSource)
	Construct with a name and data set.
void	SetVisibleColumns (System.String[] visibleColumns)
	<exclude>
override void	UpdateColors ()
	Update the Control colors according to the CUI settings.
override ICustomizationState	SaveState ()
	Create and fill in a customization state object for the current settings.
override bool	LoadState (ICustomizationState aState)
	Load the settings configuration from a serialized state.
void	RaiseSyncSelectionAllowedChanged ()
	Raises the SyncSelectionAllowedChanged event.
void	DeactivateSyncSelection ()
	Temporarily turns off SyncSelection without affecting the SyncSelectionEnabled setting.
void	ResetSyncSelectionActive ()
	Resets SyncSelection to its SyncSelectionEnabled setting after it has been deactivated.
void	PullSelectionFromScene ()
	Pull the current node selection from the scene and select the corresponding rows in the Explorer UI.
void	PushSelectionToScene ()
	Select nodes in the scene corresponding to the nodes currently selected in the Explorer UI.
Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used.
override ExplorerCustomizationState	CreateState ()
	Create a specialized customization state object for this class.
virtual void	PullIfSynchingSelection ()
	Pull the Selection from the Scene if Sync Selection is currently active.
virtual void	OnSyncSelectionAllowedChanged (EventArgs e)
	Raises the SyncSelectionAllowedChanged event.
override AdvancedSearch.AdvancedFilter	CreateAdvancedFilter ()
	Creates an AdvancedFilter instance configured for the RichSceneExplorerControl's data set.
virtual void	OnSyncSelectionStateChanged ()
	Raises the SyncSelectionStateChanged event.
override void	OnListDoubleClick (EventArgs e)
	Overrides OnListDoubleClick() to handle the double click event on any cell in the name column.
Properties
bool	DisplayInfluences [get, set]
	Determines if influences of the selected nodes are highlighted.
bool	DisplayDependants [get, set]
bool	SelectInfluences [get, set]
	Determines if influences of the selected nodes are automatically added to the selection set.
bool	SelectDependants [get, set]
	Determines if dependants of the selected nodes are automatically added to the selection set.
override QuickRegexFindHandler	FindHandler [set]
	Performs quick searches for this explorer control.
bool	SyncSelectionButtonVisible [get, set]
	Determines if the Sync Selection button is shown in the UI.
bool	SyncSelectionAllowed [get, set]
	Policy controlling if Sync Selection may be enabled.
virtual bool	InitializeSelectionEnabled [get, set]
	Determines if this Explorer Control will initialize its selection to the current scene selection when the control made visible.
bool	SyncSelectionEnabled [get, set]
	Determines if changes to the selection in the scene will be automatically reflected in the Explorer UI and vice-versa.
bool	FilterSelectionSetEnabled [get, set]
virtual bool	SyncSelectionActive [get]
	Transient setting for controlling whether SyncSelection is currently used.
Events
EventHandler	SyncSelectionAllowedChanged
	Occurs when the SyncSelectionAllowed policy changes.
EventHandler	SyncSelectionStateChanged
	Occurs when the SyncSelectionEnabled setting changes.

---

Constructor & Destructor Documentation

MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::RichSceneExplorerControl

(

)

[inline]

Default constructor.

Not bound to any data set.

MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::RichSceneExplorerControl	(	String	aName,
		ExplorerFramework.DataFacade	aDataSource
	)		[inline]

Construct with a name and data set.

Parameters:

aName	Name for this Explorer.
aDataSource	Data set explored by this explorer.

---

Member Function Documentation

void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::SetVisibleColumns

(

System.String[]

visibleColumns

)

[inline]

<exclude>

Modifies the width of each visible column so that the contents of its cells are not truncated, if possible.

override void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::Dispose

(

bool

disposing

)

[inline, protected]

Clean up any resources being used.

Parameters:

disposing

true if managed resources should be disposed; otherwise, false.

Reimplemented from MaxCustomControls::ExplorerControl.

override void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::UpdateColors

(

)

[inline, virtual]

Update the Control colors according to the CUI settings.

Implements the CuiUpdatable interface.

Reimplemented from MaxCustomControls::ExplorerControl.

override ExplorerCustomizationState MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::CreateState

(

)

[inline, protected, virtual]

Create a specialized customization state object for this class.

Returns:

A specialized customization state object for this class.

Reimplemented from MaxCustomControls::ExplorerControl.

override ICustomizationState MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::SaveState

(

)

[inline, virtual]

Create and fill in a customization state object for the current settings.

Overrides the base implementation to add properties specific to the Scene Explorer.

Returns:

A customization state object for serializing the current settings.

Reimplemented from MaxCustomControls::ExplorerControl.

override bool MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::LoadState

(

ICustomizationState

aState

)

[inline, virtual]

Load the settings configuration from a serialized state.

Overrides the base implementation to handle properties specific to the Scene Explorer.

Parameters:

aState

A serialized customization state containing the desired settings.

Reimplemented from MaxCustomControls::ExplorerControl.

virtual void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::PullIfSynchingSelection

(

)

[inline, protected, virtual]

Pull the Selection from the Scene if Sync Selection is currently active.

virtual void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::OnSyncSelectionAllowedChanged

(

EventArgs

e

)

[inline, protected, virtual]

Raises the SyncSelectionAllowedChanged event.

Parameters:

e

void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::RaiseSyncSelectionAllowedChanged

(

)

[inline]

Raises the SyncSelectionAllowedChanged event.

override AdvancedSearch.AdvancedFilter MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::CreateAdvancedFilter

(

)

[inline, protected, virtual]

Creates an AdvancedFilter instance configured for the RichSceneExplorerControl's data set.

Reimplemented from MaxCustomControls::ExplorerControl.

void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::DeactivateSyncSelection

(

)

[inline]

Temporarily turns off SyncSelection without affecting the SyncSelectionEnabled setting.

void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::ResetSyncSelectionActive

(

)

[inline]

Resets SyncSelection to its SyncSelectionEnabled setting after it has been deactivated.

void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::PullSelectionFromScene

(

)

[inline]

Pull the current node selection from the scene and select the corresponding rows in the Explorer UI.

void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::PushSelectionToScene

(

)

[inline]

Select nodes in the scene corresponding to the nodes currently selected in the Explorer UI.

virtual void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::OnSyncSelectionStateChanged

(

)

[inline, protected, virtual]

Raises the SyncSelectionStateChanged event.

override void MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::OnListDoubleClick

(

EventArgs

e

)

[inline, protected, virtual]

Overrides OnListDoubleClick() to handle the double click event on any cell in the name column.

Parameters:

e	Default event arts.

Reimplemented from MaxCustomControls::ExplorerControl.

---

Property Documentation

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

Determines if influences of the selected nodes are highlighted.

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

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

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

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

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

override QuickRegexFindHandler MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::FindHandler [set]

Performs quick searches for this explorer control.

Overrides the base set implementation to set the MatchedProperty according to the Scene Explorer's requirements.

Reimplemented from MaxCustomControls::ExplorerControl.

bool MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::SyncSelectionButtonVisible [get, set]

Determines if the Sync Selection button is shown in the UI.

bool MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::SyncSelectionAllowed [get, set]

Policy controlling if Sync Selection may be enabled.

virtual bool MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::InitializeSelectionEnabled [get, set]

Determines if this Explorer Control will initialize its selection to the current scene selection when the control made visible.

bool MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::SyncSelectionEnabled [get, set]

Determines if changes to the selection in the scene will be automatically reflected in the Explorer UI and vice-versa.

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

virtual bool MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::SyncSelectionActive [get, protected]

Transient setting for controlling whether SyncSelection is currently used.

---

Event Documentation

EventHandler MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::SyncSelectionAllowedChanged

Occurs when the SyncSelectionAllowed policy changes.

EventHandler MaxCustomControls::SceneExplorerControls::RichSceneExplorerControl::SyncSelectionStateChanged

Occurs when the SyncSelectionEnabled setting changes.