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.
FORMIT_CORE_EXPORT bool	FormIt::GroupEdit::SetInContextEditingPath (WSM::GroupInstancePath const &path)
	Set the editing context path.
FORMIT_CORE_EXPORT bool	FormIt::GroupEdit::GetShowEditedGroupOnly ()
	String attribute name identifying reference histories that should be unique before editing.
FORMIT_CORE_EXPORT void	FormIt::GroupEdit::SetShowEditedGroupOnly (bool val)
	Sets the status of the "Show Edited Group Only" option.
FORMIT_CORE_EXPORT WSM::GroupInstancePath	FormIt::GroupEdit::GetInContextEditingPath ()
	Get the editing context path.
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.
FORMIT_CORE_EXPORT void	FormIt::GroupEdit::ExittoParentContext ()
	Exit to the parent context.
FORMIT_CORE_EXPORT void	FormIt::GroupEdit::EndEditInContext ()
	End editing in context.

Function Documentation

EndEditInContext()

FORMIT_CORE_EXPORT void FormIt::GroupEdit::EndEditInContext

(

)

End editing in context.

ExittoParentContext()

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.

GetEditingHistoryID()

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.

GetInContextEditingPath()

FORMIT_CORE_EXPORT WSM::GroupInstancePath FormIt::GroupEdit::GetInContextEditingPath

(

)

Get the editing context path.

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

GetShowEditedGroupOnly()

FORMIT_CORE_EXPORT bool FormIt::GroupEdit::GetShowEditedGroupOnly

(

)

String attribute name identifying reference histories that should be unique before editing.

This is to specify group vs component behavior. The reference becomes unique when changing context. NOTE: You must run BuildAutomation/gen_formit_polyfill.py to get this constant to show up in JS. Returns the status of the "Show Edited Group Only" option.

IsEditingInContext()

FORMIT_CORE_EXPORT bool FormIt::GroupEdit::IsEditingInContext

(

)

Returns true if edit in context is happening.

IsInEditingHistory()

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

IsInEditingHistory() function.

Parameters

[in]	path	The given editing context path
[in]	bAllowReferencedGeometrySelection

SetInContextEditingPath()

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]

path

The given editing context path

SetShowEditedGroupOnly()

FORMIT_CORE_EXPORT void FormIt::GroupEdit::SetShowEditedGroupOnly

(

bool

val

)

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

Parameters

[in]

val