FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::SectionPlanes API

Description

Functions

FORMIT_CORE_EXPORT void FormIt::SectionPlanes::Clear ()
 Clear the list of section planes. More...
 
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetPlanes (1::vector< WSM::Plane > const &planes)
 Set the current Section Planes. More...
 
FORMIT_CORE_EXPORT::vector< WSM::Plane > const & FormIt::SectionPlanes::GetPlanes ()
 Get the current Section Planes. More...
 
FORMIT_CORE_EXPORT::vector< WSM::GroupInstancePath > const & FormIt::SectionPlanes::GetInstances ()
 GetInstances() function. More...
 
FORMIT_CORE_EXPORT::set< WSM::ObjectHistoryID > const & FormIt::SectionPlanes::GetPlaneLayers ()
 GetPlaneLayers() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetOutlineColor (WSM::Color const &color)
 SetOutlineColor() function. More...
 
FORMIT_CORE_EXPORT WSM::Color FormIt::SectionPlanes::GetOutlineColor ()
 GetOutlineColor() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetOutlineSize (float s)
 SetOutlineSize() function. More...
 
FORMIT_CORE_EXPORT float FormIt::SectionPlanes::GetOutlineSize ()
 GetOutlineSize() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetSectionIndicatorsVisibility (bool visible)
 SetSectionIndicatorsVisibility() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetPocheColor (WSM::Color const &color)
 SetPocheColor() function. More...
 
FORMIT_CORE_EXPORT WSM::Color FormIt::SectionPlanes::GetPocheColor ()
 GetPocheColor() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::EnablePocheColor (bool enable)
 EnablePocheColor() function. More...
 
FORMIT_CORE_EXPORT bool FormIt::SectionPlanes::IsPocheColorEnabled ()
 IsPocheColorEnabled() function. More...
 
FORMIT_CORE_EXPORT bool FormIt::SectionPlanes::SectionPlaneHistoryChanged ()
 SectionPlaneHistoryChanged returns true if the section plane History has changed. More...
 
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetLastSectionRefHistory (size_t historyId)
 Set the History ID that represents a section plane. More...
 
FORMIT_CORE_EXPORT size_t FormIt::SectionPlanes::GetLastSectionRefHistory ()
 Get the History ID that represents a section plane. More...
 

Function Documentation

FORMIT_CORE_EXPORT void FormIt::SectionPlanes::Clear ( )

Clear the list of section planes.

FORMIT_CORE_EXPORT void FormIt::SectionPlanes::EnablePocheColor ( bool  enable)

EnablePocheColor() function.

Parameters
[in]enable
FORMIT_CORE_EXPORT ::vector<WSM::GroupInstancePath> const& FormIt::SectionPlanes::GetInstances ( )

GetInstances() function.

FORMIT_CORE_EXPORT size_t FormIt::SectionPlanes::GetLastSectionRefHistory ( )

Get the History ID that represents a section plane.

FORMIT_CORE_EXPORT WSM::Color FormIt::SectionPlanes::GetOutlineColor ( )

GetOutlineColor() function.

FORMIT_CORE_EXPORT float FormIt::SectionPlanes::GetOutlineSize ( )

GetOutlineSize() function.

FORMIT_CORE_EXPORT ::set<WSM::ObjectHistoryID> const& FormIt::SectionPlanes::GetPlaneLayers ( )

GetPlaneLayers() function.

FORMIT_CORE_EXPORT ::vector<WSM::Plane> const& FormIt::SectionPlanes::GetPlanes ( )

Get the current Section Planes.

FORMIT_CORE_EXPORT WSM::Color FormIt::SectionPlanes::GetPocheColor ( )

GetPocheColor() function.

FORMIT_CORE_EXPORT bool FormIt::SectionPlanes::IsPocheColorEnabled ( )
FORMIT_CORE_EXPORT bool FormIt::SectionPlanes::SectionPlaneHistoryChanged ( )

SectionPlaneHistoryChanged returns true if the section plane History has changed.

FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetLastSectionRefHistory ( size_t  historyId)

Set the History ID that represents a section plane.

Parameters
[in]historyId
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetOutlineColor ( WSM::Color const &  color)

SetOutlineColor() function.

Parameters
[in]color
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetOutlineSize ( float  s)

SetOutlineSize() function.

Parameters
[in]s
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetPlanes ( 1::vector< WSM::Plane > const &  planes)

Set the current Section Planes.

Parameters
[in]planes
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetPocheColor ( WSM::Color const &  color)

SetPocheColor() function.

Parameters
[in]color
FORMIT_CORE_EXPORT void FormIt::SectionPlanes::SetSectionIndicatorsVisibility ( bool  visible)

SetSectionIndicatorsVisibility() function.

Parameters
[in]visible