FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::Levels Namespace Reference

Functions

FORMIT_CORE_EXPORT bool AddLevels (size_t nHistoryID, int numLevels, double startElevation, double deltaElevation, 1::vector< size_t > &aNewLevels)
 AddLevels() function. More...
 
FORMIT_CORE_EXPORT void AutoRenameLevels (size_t nHistoryId)
 Renames all levels with a default name according to the elevation order. More...
 
FORMIT_CORE_EXPORT bool ChangeLevelElevation (size_t nHistoryID, size_t aLevelID, double newElevation)
 Change the given level's elevation. More...
 
FORMIT_CORE_EXPORT bool ChangeLevelName (size_t nHistoryID, size_t aLevelID, const 1::string &newName)
 Change the given level's name. More...
 
FORMIT_CORE_EXPORT::vector< size_t > CreateDefaultLevels (size_t nHistoryID)
 Create default levels in the given History. More...
 
FORMIT_CORE_EXPORT bool DeleteLevel (size_t nHistoryID, size_t aLevelID)
 Delete the given levels in the given History. More...
 
FORMIT_CORE_EXPORT bool DeleteLevels (size_t nHistoryID, const 1::vector< size_t > &aLevelIDs)
 Delete the given levels in the given History. More...
 
FORMIT_CORE_EXPORT double GetDefaultLevelHeight ()
 Returns the default elevation difference between adjacent levels. More...
 
FORMIT_CORE_EXPORT::vector< size_t > GetLevels (size_t nHistoryID, bool sortByElevation)
 Returns a vector of all levels within a history. More...
 
FORMIT_CORE_EXPORT size_t GetNumLevels (size_t nHistoryID)
 Get the number of levels in the given history. More...
 
FORMIT_CORE_EXPORT double GetMinLevelElevation (size_t nHistoryID)
 Get the elevation of the lowest level in the given history. More...
 
FORMIT_CORE_EXPORT double GetMaxLevelElevation (size_t nHistoryID)
 Get the elevation of the highest level in the given history. More...
 
FORMIT_CORE_EXPORT::pair< bool, LevelDataGetLevelData (size_t nHistoryID, size_t levelID)
 GetLevelData() function. More...
 
FORMIT_CORE_EXPORT::vector< LevelDataGetLevelsData (size_t nHistoryID, bool sortByElevation)
 Returns a vector of LevelData for all levels within a history. More...
 
FORMIT_CORE_EXPORT bool GetLevelIDsFromSelectedObjects (size_t nHistoryID, 1::set< size_t > &aLevels)
 Union of levels of each object. More...
 
FORMIT_CORE_EXPORT bool HasLevelsInProject (bool checkVisibleOnly)
 Check if there are any manifold solid objects in the main history that have levels. More...
 
FORMIT_CORE_EXPORT bool IsExistingLevel (size_t nHistoryId, const 1::string &levelName)
 Returns true if the given Level name exists. More...
 
FORMIT_CORE_EXPORT bool IsExistingLevelByElevation (size_t nHistoryId, double elevation)
 Returns true if a level with the given elevation name exists. More...
 
FORMIT_CORE_EXPORT::pair< bool, double > 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 > 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 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 > 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 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 SetReportAreaByLevelsOnSelection (bool bON)
 SetReportAreaByLevelsOnSelection() function. More...
 
FORMIT_CORE_EXPORT double GetAreaForObjects (size_t nHistoryId, size_t aLevelId, 1::vector< size_t > const &aObjectIds)
 Return the area of the level on the given obejcts. More...