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

Functions

FORMIT_CORE_EXPORT size_t GetHistoryID ()
 
FORMIT_CORE_EXPORT size_t GetMemorySize (bool bCollapsedHistoryWithLiveObjsOnly)
 Get the memory size (in bytes) the History of the main Model with all Object versions or collapsed history with only live Objects. More...
 
FORMIT_CORE_EXPORT UnitType GetUnitTypeCurrent ()
 Get the UnitType of the current Model. More...
 
FORMIT_CORE_EXPORT bool IsImperialUnitType (UnitType unitType)
 Returns true if the given unit type is imperial. More...
 
FORMIT_CORE_EXPORT double ImperialLengthToCurrentUnitLength (double imperialValue)
 Takes imperial value in feet and translates to the current unit system. More...
 
FORMIT_CORE_EXPORT void SetUnitTypeCurrent (UnitType type)
 Set the UnitType of the current Model. More...
 
FORMIT_CORE_EXPORT void SetCurveAccuracyOrCountCurrent (double accuracyORcount)
 Set the curve accuracy of the Model. More...
 
FORMIT_CORE_EXPORT double GetCurveAccuracyOrCountCurrent ()
 Get the curve accuracy of the Model. More...
 
FORMIT_CORE_EXPORT void SetSurfaceAccuracyOrCountCurrent (double accuracy)
 Set the surface accuracy of the Model. More...
 
FORMIT_CORE_EXPORT double GetSurfaceAccuracyOrCountCurrent ()
 Get the surface accuracy of the Model. More...
 
FORMIT_CORE_EXPORT::string GetGroupHistoryName (size_t nHistoryId)
 Get the name for the given history. More...
 
FORMIT_CORE_EXPORT void SetGroupHistoryName (size_t nHistoryId, const 1::string &sHistoryName)
 Set the name for the given history. More...
 
FORMIT_CORE_EXPORT bool IsModified ()
 IsModified returns true if the Model has been modified. More...
 
FORMIT_CORE_EXPORT void ResetModified ()
 ResetModified sets the Model to unmodified. More...
 
FORMIT_CORE_EXPORT::string GetObjectName (size_t nHistoryID, size_t nObjectID)
 Get the name for the given Object. More...
 
FORMIT_CORE_EXPORT void SetObjectName (size_t nHistoryID, size_t nObjectID, 1::string const &name)
 Set the name for the given Object. More...
 
FORMIT_CORE_EXPORT bool ObjectReportsAreaByLevel (size_t nHistoryID, size_t nObjectID)
 Get whether the Object reports area by level or not. More...
 
FORMIT_CORE_EXPORT double GetProjectSiteArea ()
 Get the site area of the model. More...
 
FORMIT_CORE_EXPORT void SetTotalAreaOfSite (double area)
 Set the total site area of the model. More...
 
FORMIT_CORE_EXPORT double GetProjectTargetArea ()
 Get the total site area of the model. More...
 
FORMIT_CORE_EXPORT double GetTotalGrossArea ()
 Get the sum of all level areas in the model. More...
 
FORMIT_CORE_EXPORT double GetLinearDefault (double imperialValue)
 Get the default value that is equivalent to the given linear imperial value. More...