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

Description

Functions

FORMIT_CORE_EXPORT size_t FormIt::GroupEdit::GetEditingHistoryID ()
 Get the id of the history that is currently edited, or the id of the main history, if no group is edited. More...
 
FORMIT_CORE_EXPORT bool FormIt::GroupEdit::SetInContextEditingPath (WSM::GroupInstancePath const &path)
 Set the editing context path. More...
 
FORMIT_CORE_EXPORT bool FormIt::GroupEdit::GetShowEditedGroupOnly ()
 Returns the status of the "Show Edited Group Only" option. More...
 
FORMIT_CORE_EXPORT void FormIt::GroupEdit::SetShowEditedGroupOnly (bool val)
 Sets the status of the "Show Edited Group Only" option. More...
 
FORMIT_CORE_EXPORT WSM::GroupInstancePath FormIt::GroupEdit::GetInContextEditingPath ()
 Get the editing context path. More...
 
FORMIT_CORE_EXPORT bool FormIt::GroupEdit::IsEditingInContext ()
 Returns true if edit in context is happening. More...
 
FORMIT_CORE_EXPORT bool FormIt::GroupEdit::IsInEditingHistory (WSM::GroupInstancePath const &path, bool bAllowReferencedGeometrySelection=false)
 IsInEditingHistory() function. More...
 
FORMIT_CORE_EXPORT void FormIt::GroupEdit::ExittoParentContext ()
 Exit to the parent context. More...
 
FORMIT_CORE_EXPORT void FormIt::GroupEdit::EndEditInContext ()
 End editing in context. More...
 

Function Documentation

FORMIT_CORE_EXPORT void FormIt::GroupEdit::EndEditInContext ( )

End editing in context.

FORMIT_CORE_EXPORT void FormIt::GroupEdit::ExittoParentContext ( )

Exit to the parent context.

If editing a nested group, this method will exit to the parent context as defined by the editing path.

FORMIT_CORE_EXPORT size_t FormIt::GroupEdit::GetEditingHistoryID ( )

Get the id of the history that is currently edited, or the id of the main history, if no group is edited.

FORMIT_CORE_EXPORT WSM::GroupInstancePath FormIt::GroupEdit::GetInContextEditingPath ( )

Get the editing context path.

The path is to the specific instance that is being edited.

FORMIT_CORE_EXPORT bool FormIt::GroupEdit::GetShowEditedGroupOnly ( )

Returns the status of the "Show Edited Group Only" option.

FORMIT_CORE_EXPORT bool FormIt::GroupEdit::IsEditingInContext ( )

Returns true if edit in context is happening.

FORMIT_CORE_EXPORT bool FormIt::GroupEdit::IsInEditingHistory ( WSM::GroupInstancePath const &  path,
bool  bAllowReferencedGeometrySelection = false 
)

IsInEditingHistory() function.

Parameters
[in]pathThe given editing context path
[in]bAllowReferencedGeometrySelection
FORMIT_CORE_EXPORT bool FormIt::GroupEdit::SetInContextEditingPath ( WSM::GroupInstancePath const &  path)

Set the editing context path.

The path is to the specific instance that should be edited.

Parameters
[in]pathThe given editing context path
FORMIT_CORE_EXPORT void FormIt::GroupEdit::SetShowEditedGroupOnly ( bool  val)

Sets the status of the "Show Edited Group Only" option.

Parameters
[in]val