FormIt::Selection API

Description

Functions
FORMIT_CORE_EXPORT void	FormIt::Selection::SetObjectTypeFilter (const WSM::Utils::ObjectTypeFilter &filter)
	SetObjectTypeFilter() function. More...
FORMIT_CORE_EXPORT WSM::Utils::ObjectTypeFilter	FormIt::Selection::GetObjectTypeFilter ()
	GetObjectTypeFilter() function. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::ClearPreSelections ()
	ClearPreSelections() function. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::ClearSelections ()
	ClearSelections() function. More...
FORMIT_CORE_EXPORT const ::vector< WSM::GroupInstancePath > &	FormIt::Selection::GetPreSelections ()
	GetPreSelections() function. More...
FORMIT_CORE_EXPORT const ::vector< WSM::GroupInstancePath > &	FormIt::Selection::GetSelections ()
	GetSelections() function. More...
FORMIT_CORE_EXPORT bool	FormIt::Selection::HasPreSelections ()
	HasPreSelections() function. More...
FORMIT_CORE_EXPORT bool	FormIt::Selection::HasSelections ()
	HasSelections() function. More...
FORMIT_CORE_EXPORT bool	FormIt::Selection::IsSelected (WSM::GroupInstancePath const &path)
	Is this GroupInstancePath in the selections. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::AddSelections (const 1::vector< WSM::GroupInstancePath > &objectIDs)
	Add a vector of GroupInstancePath to the selection. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::SetSelections (const 1::vector< WSM::GroupInstancePath > &objectIDs)
	SetSelections() function. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::SetPreSelections (const 1::vector< WSM::GroupInstancePath > &objectIDs)
	SetPreSelections sets the pre-selected objects in the SelectionSet. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::SetPreSelections (const WSM::GroupInstancePath &firstPreselection, const 1::vector< WSM::GroupInstancePath > &allPreselections)
	SetPreSelections() function. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::CommitPreselections ()
	Sets the selection using the current pre-selection. More...
FORMIT_CORE_EXPORT const WSM::GroupInstancePath &	FormIt::Selection::GetFirstPreSelectedObject ()
	Get the first pre-selected object. More...
FORMIT_CORE_EXPORT const WSM::GroupInstancePath &	FormIt::Selection::GetFirstSelectedObject ()
	Get the first selected object. More...
FORMIT_CORE_EXPORT const ::vector< WSM::GroupInstancePath > &	FormIt::Selection::GetPreSelectedObjects ()
	Get the pre-selected objects. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::ToggleObjects (const 1::vector< WSM::GroupInstancePath > &objectIDs)
	ToggleObjects toggles the object selection- If they're in the list, it removes them, else it adds them. More...
FORMIT_CORE_EXPORT void	FormIt::Selection::SelectAll ()
	Sets the selection to all visible Objects. More...
FORMIT_CORE_EXPORT const WSM::GroupInstancePath &	FormIt::Selection::GetContextMenuObject (WSM::Point2d *pickPoint)
	Get the object selected by the context menu click. More...

Function Documentation

FORMIT_CORE_EXPORT void FormIt::Selection::AddSelections

(

const 1::vector< WSM::GroupInstancePath > &

objectIDs

)

Add a vector of GroupInstancePath to the selection.

Parameters

[in]

objectIDs

FORMIT_CORE_EXPORT void FormIt::Selection::ClearPreSelections

(

)

ClearPreSelections() function.

FORMIT_CORE_EXPORT void FormIt::Selection::ClearSelections

(

)

ClearSelections() function.

FORMIT_CORE_EXPORT void FormIt::Selection::CommitPreselections

(

)

Sets the selection using the current pre-selection.

FORMIT_CORE_EXPORT const WSM::GroupInstancePath& FormIt::Selection::GetContextMenuObject

(

WSM::Point2d *

pickPoint

)

Get the object selected by the context menu click.

Parameters

[out]

pickPoint

FORMIT_CORE_EXPORT const WSM::GroupInstancePath& FormIt::Selection::GetFirstPreSelectedObject

(

)

Get the first pre-selected object.

FORMIT_CORE_EXPORT const WSM::GroupInstancePath& FormIt::Selection::GetFirstSelectedObject

(

)

Get the first selected object.

FORMIT_CORE_EXPORT WSM::Utils::ObjectTypeFilter FormIt::Selection::GetObjectTypeFilter

(

)

GetObjectTypeFilter() function.

FORMIT_CORE_EXPORT const ::vector<WSM::GroupInstancePath>& FormIt::Selection::GetPreSelectedObjects

(

)

Get the pre-selected objects.

FORMIT_CORE_EXPORT const ::vector<WSM::GroupInstancePath>& FormIt::Selection::GetPreSelections

(

)

GetPreSelections() function.

FORMIT_CORE_EXPORT const ::vector<WSM::GroupInstancePath>& FormIt::Selection::GetSelections

(

)

GetSelections() function.

FORMIT_CORE_EXPORT bool FormIt::Selection::HasPreSelections

(

)

HasPreSelections() function.

FORMIT_CORE_EXPORT bool FormIt::Selection::HasSelections

(

)

HasSelections() function.

FORMIT_CORE_EXPORT bool FormIt::Selection::IsSelected

(

WSM::GroupInstancePath const &

path

)

Is this GroupInstancePath in the selections.

Parameters

[in]

path

The given editing context path

FORMIT_CORE_EXPORT void FormIt::Selection::SelectAll

(

)

Sets the selection to all visible Objects.

FORMIT_CORE_EXPORT void FormIt::Selection::SetObjectTypeFilter

(

const WSM::Utils::ObjectTypeFilter &

filter

)

SetObjectTypeFilter() function.

Parameters

[in]

filter

FORMIT_CORE_EXPORT void FormIt::Selection::SetPreSelections

(

const 1::vector< WSM::GroupInstancePath > &

objectIDs

)

SetPreSelections sets the pre-selected objects in the SelectionSet.

Does not alter m_PreSelectedObject (first pre-selection).

NOT NEEDED IN JS API

FORMIT_CORE_EXPORT void FormIt::Selection::SetPreSelections	(	const WSM::GroupInstancePath &	firstPreselection,
		const 1::vector< WSM::GroupInstancePath > &	allPreselections
	)

SetPreSelections() function.

Parameters

[in]	firstPreselection
[in]	allPreselections

FORMIT_CORE_EXPORT void FormIt::Selection::SetSelections

(

const 1::vector< WSM::GroupInstancePath > &

objectIDs

)

SetSelections() function.

Parameters

[in]

objectIDs

FORMIT_CORE_EXPORT void FormIt::Selection::ToggleObjects

(

const 1::vector< WSM::GroupInstancePath > &

objectIDs

)

ToggleObjects toggles the object selection- If they're in the list, it removes them, else it adds them.

Parameters

[in]

objectIDs