Description

Functions
FORMIT_CORE_EXPORT bool	FormIt::Levels::AddLevels (size_t nHistoryID, int numLevels, double startElevation, double deltaElevation, 1::vector< size_t > &aNewLevels)
	AddLevels() function. More...

FORMIT_CORE_EXPORT void	FormIt::Levels::AutoRenameLevels (size_t nHistoryId)
	Renames all levels with a default name according to the elevation order. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::ChangeLevelElevation (size_t nHistoryID, size_t aLevelID, double newElevation)
	Change the given level's elevation. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::ChangeLevelName (size_t nHistoryID, size_t aLevelID, const 1::string &newName)
	Change the given level's name. More...

FORMIT_CORE_EXPORT::vector< size_t >	FormIt::Levels::CreateDefaultLevels (size_t nHistoryID)
	Create default levels in the given History. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::DeleteLevel (size_t nHistoryID, size_t aLevelID)
	Delete the given levels in the given History. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::DeleteLevels (size_t nHistoryID, const 1::vector< size_t > &aLevelIDs)
	Delete the given levels in the given History. More...

FORMIT_CORE_EXPORT double	FormIt::Levels::GetDefaultLevelHeight ()
	Returns the default elevation difference between adjacent levels. More...

FORMIT_CORE_EXPORT::vector< size_t >	FormIt::Levels::GetLevels (size_t nHistoryID, bool sortByElevation)
	Returns a vector of all levels within a history. More...

FORMIT_CORE_EXPORT size_t	FormIt::Levels::GetNumLevels (size_t nHistoryID)
	Get the number of levels in the given history. More...

FORMIT_CORE_EXPORT double	FormIt::Levels::GetMinLevelElevation (size_t nHistoryID)
	Get the elevation of the lowest level in the given history. More...

FORMIT_CORE_EXPORT double	FormIt::Levels::GetMaxLevelElevation (size_t nHistoryID)
	Get the elevation of the highest level in the given history. More...

FORMIT_CORE_EXPORT::pair< bool, LevelData >	FormIt::Levels::GetLevelData (size_t nHistoryID, size_t levelID)
	GetLevelData() function. More...

FORMIT_CORE_EXPORT::vector< LevelData >	FormIt::Levels::GetLevelsData (size_t nHistoryID, bool sortByElevation)
	Returns a vector of LevelData for all levels within a history. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::GetLevelIDsFromSelectedObjects (size_t nHistoryID, 1::set< size_t > &aLevels)
	Union of levels of each object. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::HasLevelsInProject (bool checkVisibleOnly)
	Check if there are any manifold solid objects in the main history that have levels. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::IsExistingLevel (size_t nHistoryId, const 1::string &levelName)
	Returns true if the given Level name exists. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::IsExistingLevelByElevation (size_t nHistoryId, double elevation)
	Returns true if a level with the given elevation name exists. More...

FORMIT_CORE_EXPORT::pair< bool, double >	FormIt::Levels::IsValidLevelDeltaElevation (size_t nHistoryID, const 1::string &deltaElevationString, size_t numLevels, 1::string &errorMsg)
	Checks if the string containing the delta elevation is valid. More...

FORMIT_CORE_EXPORT::pair< bool, double >	FormIt::Levels::IsValidLevelElevation (size_t nHistoryID, size_t aLevelId, const 1::string &elevationString, 1::string &errorMsg)
	Checks if the string containing the elevation is valid for a level. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::IsValidLevelName (size_t nHistoryID, size_t aLevelId, const 1::string &newLevelName, 1::string &errorMsg)
	Returns true is the given level name is valid. More...

FORMIT_CORE_EXPORT::pair< bool, size_t >	FormIt::Levels::IsValidNumberOfLevelsToAdd (size_t nHistoryID, const 1::string &numLevelsString, double deltaElevation, 1::string &errorMsg)
	Checks if the string containing the number of levels is valid. More...

FORMIT_CORE_EXPORT bool	FormIt::Levels::SetLevelsToSelectedObjects (size_t nHistoryID, const 1::vector< size_t > &aLevelList)
	Set the given levels to be the levels for all currently selected objects. More...

FORMIT_CORE_EXPORT void	FormIt::Levels::SetReportAreaByLevelsOnSelection (bool bON)
	SetReportAreaByLevelsOnSelection() function. More...

FORMIT_CORE_EXPORT double	FormIt::Levels::GetAreaForObjects (size_t nHistoryId, size_t aLevelId, 1::vector< size_t > const &aObjectIds)
	Return the area of the level on the given obejcts. More...

Function Documentation

FORMIT_CORE_EXPORT bool FormIt::Levels::AddLevels	(	size_t	nHistoryID,
		int	numLevels,
		double	startElevation,
		double	deltaElevation,
		1::vector< size_t > &	aNewLevels
	)

AddLevels() function.

Parameters

[in]	nHistoryID	ID of the given History
[in]	numLevels
[in]	startElevation
[in]	deltaElevation	Indicates the spacing between the levels intended to be added.
[out]	aNewLevels

FORMIT_CORE_EXPORT void FormIt::Levels::AutoRenameLevels ( size_t nHistoryId )

Renames all levels with a default name according to the elevation order.

Parameters

[in] nHistoryId ID of the given History

FORMIT_CORE_EXPORT bool FormIt::Levels::ChangeLevelElevation	(	size_t	nHistoryID,
		size_t	aLevelID,
		double	newElevation
	)

Change the given level's elevation.

Parameters

[in]	nHistoryID	ID of the given History
[in]	aLevelID
[in]	newElevation

FORMIT_CORE_EXPORT bool FormIt::Levels::ChangeLevelName	(	size_t	nHistoryID,
		size_t	aLevelID,
		const 1::string &	newName
	)

Change the given level's name.

Parameters

[in]	nHistoryID	ID of the given History
[in]	aLevelID
[in]	newName

FORMIT_CORE_EXPORT ::vector<size_t> FormIt::Levels::CreateDefaultLevels ( size_t nHistoryID )

Create default levels in the given History.

Parameters

[in] nHistoryID ID of the given History

FORMIT_CORE_EXPORT bool FormIt::Levels::DeleteLevel	(	size_t	nHistoryID,
		size_t	aLevelID
	)

Delete the given levels in the given History.

Parameters

[in]	nHistoryID	ID of the given History
[in]	aLevelID

FORMIT_CORE_EXPORT bool FormIt::Levels::DeleteLevels	(	size_t	nHistoryID,
		const 1::vector< size_t > &	aLevelIDs
	)

Delete the given levels in the given History.

Parameters

[in]	nHistoryID	ID of the given History
[in]	aLevelIDs

FORMIT_CORE_EXPORT double FormIt::Levels::GetAreaForObjects	(	size_t	nHistoryId,
		size_t	aLevelId,
		1::vector< size_t > const &	aObjectIds
	)

Return the area of the level on the given obejcts.

Parameters

[in]	nHistoryID	History Id
[in]	aLevelId	Level id
[in]	aObjectIds	Vector of objects for which to calculate the level area
[in]	nHistoryId	ID of the given History

FORMIT_CORE_EXPORT double FormIt::Levels::GetDefaultLevelHeight ( )

Returns the default elevation difference between adjacent levels.

FORMIT_CORE_EXPORT ::pair<bool, LevelData> FormIt::Levels::GetLevelData	(	size_t	nHistoryID,
		size_t	levelID
	)

GetLevelData() function.

Parameters

[in]	nHistoryID	ID of the given History
[in]	levelID

FORMIT_CORE_EXPORT bool FormIt::Levels::GetLevelIDsFromSelectedObjects	(	size_t	nHistoryID,
		1::set< size_t > &	aLevels
	)

Union of levels of each object.

Parameters

[in]	nHistoryID	ID of the given History
[out]	aLevels

FORMIT_CORE_EXPORT ::vector<size_t> FormIt::Levels::GetLevels	(	size_t	nHistoryID,
		bool	sortByElevation
	)

Returns a vector of all levels within a history.

Parameters

[in]	nHistoryID	ID of the given History
[in]	sortByElevation	Set to true to sort the levels by elevation in ascending order

FORMIT_CORE_EXPORT ::vector<LevelData> FormIt::Levels::GetLevelsData	(	size_t	nHistoryID,
		bool	sortByElevation
	)

Returns a vector of LevelData for all levels within a history.

Parameters

[in]	nHistoryID	ID of the given History
[in]	sortByElevation	Set to true to sort the levels by elevation in ascending order

FORMIT_CORE_EXPORT double FormIt::Levels::GetMaxLevelElevation ( size_t nHistoryID )

Get the elevation of the highest level in the given history.

Parameters

[in] nHistoryID ID of the given History

FORMIT_CORE_EXPORT double FormIt::Levels::GetMinLevelElevation ( size_t nHistoryID )

Get the elevation of the lowest level in the given history.

Parameters

[in] nHistoryID ID of the given History

FORMIT_CORE_EXPORT size_t FormIt::Levels::GetNumLevels ( size_t nHistoryID )

Get the number of levels in the given history.

Parameters

[in] nHistoryID ID of the given History

FORMIT_CORE_EXPORT bool FormIt::Levels::HasLevelsInProject ( bool checkVisibleOnly )

Check if there are any manifold solid objects in the main history that have levels.

applied. If checkVisibleOnly is true, only visible objects are checked. Returns true, if there is at least one manifold solid object with at least one level.

Parameters

[in] checkVisibleOnly

FORMIT_CORE_EXPORT bool FormIt::Levels::IsExistingLevel	(	size_t	nHistoryId,
		const 1::string &	levelName
	)

Returns true if the given Level name exists.

Parameters

[in]	nHistoryId	ID of the given History
[in]	levelName

FORMIT_CORE_EXPORT bool FormIt::Levels::IsExistingLevelByElevation	(	size_t	nHistoryId,
		double	elevation
	)

Returns true if a level with the given elevation name exists.

Parameters

[in]	nHistoryId	ID of the given History
[in]	elevation

FORMIT_CORE_EXPORT ::pair<bool, double> FormIt::Levels::IsValidLevelDeltaElevation	(	size_t	nHistoryID,
		const 1::string &	deltaElevationString,
		size_t	numLevels,
		1::string &	errorMsg
	)

Checks if the string containing the delta elevation is valid.

Returns Result (Success) and the elevation. Also returns an error string that can be posted in the UI if the string to value conversion fails.

Parameters

[in]	nHistoryID	ID of the given History
[in]	deltaElevationString
[in]	numLevels	Indicates the number of levels intended to be added.
[out]	errorMsg

FORMIT_CORE_EXPORT ::pair<bool, double> FormIt::Levels::IsValidLevelElevation	(	size_t	nHistoryID,
		size_t	aLevelId,
		const 1::string &	elevationString,
		1::string &	errorMsg
	)

Checks if the string containing the elevation is valid for a level.

Returns success and the elevation. Also returns an error string that can be posted in the UI, if the string to value conversion fails.

Parameters

[in]	nHistoryID	ID of the given History
[in]	aLevelId	Level id
[in]	elevationString
[out]	errorMsg

FORMIT_CORE_EXPORT bool FormIt::Levels::IsValidLevelName	(	size_t	nHistoryID,
		size_t	aLevelId,
		const 1::string &	newLevelName,
		1::string &	errorMsg
	)

Returns true is the given level name is valid.

Parameters

[in]	nHistoryID	ID of the given History
[in]	aLevelId	Level id
[in]	newLevelName
[out]	errorMsg

FORMIT_CORE_EXPORT ::pair<bool, size_t> FormIt::Levels::IsValidNumberOfLevelsToAdd	(	size_t	nHistoryID,
		const 1::string &	numLevelsString,
		double	deltaElevation,
		1::string &	errorMsg
	)

Checks if the string containing the number of levels is valid.

Returns success and the number of levels. Also returns an error string that can be posted in the UI, if the string to value conversion fails.

Parameters

[in]	nHistoryID	ID of the given History
[in]	numLevelsString
[in]	deltaElevation	Indicates the spacing between the levels intended to be added.
[out]	errorMsg

FORMIT_CORE_EXPORT bool FormIt::Levels::SetLevelsToSelectedObjects	(	size_t	nHistoryID,
		const 1::vector< size_t > &	aLevelList
	)

Set the given levels to be the levels for all currently selected objects.

Parameters

[in]	nHistoryID	ID of the given History
[in]	aLevelList

FORMIT_CORE_EXPORT void FormIt::Levels::SetReportAreaByLevelsOnSelection ( bool bON )

SetReportAreaByLevelsOnSelection() function.

Parameters

[in] bON

Description

Functions

Function Documentation