Sapien::Hierarchy Namespace Reference

Namespace containing functions for interacting with the scenario hierarchy. More...

Functions
SAPIEN_LIB_API void	PrepareHierarchy ()
	Prepares a new scenario hierarchy. More...
SAPIEN_LIB_API void	ReleaseHierarchy ()
	Releases any data used by the scenario hierarchy. More...
SAPIEN_LIB_API BlamScenarioHierarchy *	GetHierarchy ()
	Retrieves the current scenario hierarchy. More...
SAPIEN_LIB_API void	SaveScenario ()
	Attempts to save the current hierarchy data back to the scenario tag. More...
SAPIEN_LIB_API int	ReserveFolderIndex ()

Detailed Description

Namespace containing functions for interacting with the scenario hierarchy.

The scenario hierarchy is a more user-friendly representation of the data contained within a scenario tag. It will display all objects placed within a scenario, including starting points, volumes, objects, and more.

Function Documentation

GetHierarchy()

BlamScenarioHierarchy * Sapien::Hierarchy::GetHierarchy

(

)

Retrieves the current scenario hierarchy.

Returns

Pointer to the current scenario hierarchy.

Here is the caller graph for this function:

PrepareHierarchy()

void Sapien::Hierarchy::PrepareHierarchy

(

)

Prepares a new scenario hierarchy.

This will also destroy any existing hierarchy data, if it is already present.

Here is the call graph for this function:

Here is the caller graph for this function:

ReleaseHierarchy()

void Sapien::Hierarchy::ReleaseHierarchy

(

)

Releases any data used by the scenario hierarchy.

Here is the caller graph for this function:

ReserveFolderIndex()

int Sapien::Hierarchy::ReserveFolderIndex

(

)

SaveScenario()

void Sapien::Hierarchy::SaveScenario

(

)

Attempts to save the current hierarchy data back to the scenario tag.