This reference page is linked to from the following overview topics: Managing Scene States.

Detailed Description

This class is the public interface to the scene state feature.

#include <ISceneStateManager.h>

Inheritance diagram for ISceneStateManager:

Public Types
enum	SceneStatePart { eIncludeLightProperties = 0, eIncludeLightTM = 1, eIncludeObjectProperties = 2, eIncludeCameraTM = 3, eIncludeCameraProperties = 4, eIncludeLayerProperties = 5, eIncludeLayerAssignment = 6, eIncludeMaterials = 7, eIncludeEnvironment = 8, eIncludeAnimationLayerProperties = 9 }
	Definition of scene state parts. More...
enum	{ E_GET_COUNT, E_GET, E_FIND, E_CAPTURE, E_RESTORE, E_DELETE, E_RENAME, E_GET_PARTS, E_GET_NUM_PARTS, E_PART_TO_INDEX, E_INDEX_TO_PART, E_CAPTURE_ALL_PARTS, E_RESTORE_ALL_PARTS }
Public Member Functions
virtual int	GetSceneStateCount ()=0
	Get the number of scene states stored in the scene.
virtual const MCHAR *	GetSceneState (int index)=0
	Get the name of the scene state at this index.
virtual int	FindSceneState (const MCHAR *name)=0
	Find the index of the scene state with this name.
virtual bool	CaptureState (const MCHAR *name)=0
	Capture, or save, a scene state. All scene state parts will be saved.
virtual bool	CaptureState (const MCHAR *name, BitArray parts)=0
	Capture, or save, a scene state with a specific set of parts.
virtual bool	RestoreState (const MCHAR *name)=0
	Restore a scene state. All scene state parts included in the scene state will be restored.
virtual bool	RestoreState (const MCHAR *name, BitArray parts)=0
	Restore a scene state.
virtual bool	DeleteState (const MCHAR *name)=0
	Delete the scene state with this name.
virtual bool	RenameState (const MCHAR oldName, const MCHAR newName)=0
	Rename a scene state.
virtual BitArray	GetSceneStateParts (const MCHAR *name)=0
	Get the parts that are stored in a specific scene state.
virtual void	DoManageDialog ()=0
	Open the Scene State manager dialog.
virtual void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags=FILE_ENUM_ALL)=0
	Enumerate external files used by objects stored in the scene states.

Member Enumeration Documentation

enum SceneStatePart

Search for all occurrences

Definition of scene state parts.

Each part is represented by a bit in a BitArray

Enumerator:

eIncludeLightProperties	Search for all occurrences
eIncludeLightTM	Search for all occurrences
eIncludeObjectProperties	Search for all occurrences
eIncludeCameraTM	Search for all occurrences
eIncludeCameraProperties	Search for all occurrences
eIncludeLayerProperties	Search for all occurrences
eIncludeLayerAssignment	Search for all occurrences
eIncludeMaterials	Search for all occurrences
eIncludeEnvironment	Search for all occurrences
eIncludeAnimationLayerProperties	Search for all occurrences

                        {
        eIncludeLightProperties = 0,
        eIncludeLightTM = 1,
        eIncludeObjectProperties = 2,
        eIncludeCameraTM = 3,
        eIncludeCameraProperties = 4,
        eIncludeLayerProperties = 5,
        eIncludeLayerAssignment = 6,
        eIncludeMaterials = 7,
        eIncludeEnvironment = 8,
        eIncludeAnimationLayerProperties =9,
    };

anonymous enum

Search for all occurrences

Enumerator:

E_GET_COUNT	Search for all occurrences
E_GET	Search for all occurrences
E_FIND	Search for all occurrences
E_CAPTURE	Search for all occurrences
E_RESTORE	Search for all occurrences
E_DELETE	Search for all occurrences
E_RENAME	Search for all occurrences
E_GET_PARTS	Search for all occurrences
E_GET_NUM_PARTS	Search for all occurrences
E_PART_TO_INDEX	Search for all occurrences
E_INDEX_TO_PART	Search for all occurrences
E_CAPTURE_ALL_PARTS	Search for all occurrences
E_RESTORE_ALL_PARTS	Search for all occurrences

    { 
        E_GET_COUNT,
        E_GET,
        E_FIND,
        E_CAPTURE,
        E_RESTORE,
        E_DELETE,
        E_RENAME,
        E_GET_PARTS,
        E_GET_NUM_PARTS,
        E_PART_TO_INDEX,
        E_INDEX_TO_PART,
        E_CAPTURE_ALL_PARTS,
        E_RESTORE_ALL_PARTS
    };