FormIt::Tools API

Description

Functions
FORMIT_CORE_EXPORT void	FormIt::Tools::ClearTools ()
	Remove active and secondary tools, go back to neutral state. More...
FORMIT_CORE_EXPORT ToolType	FormIt::Tools::GetActiveToolType ()
	GetActiveToolType() function. More...
FORMIT_CORE_EXPORT ToolType	FormIt::Tools::GetActiveToolSubType ()
	GetActiveToolSubType() function. More...
FORMIT_CORE_EXPORT bool	FormIt::Tools::IsInContinuousAction ()
	IsInContinuousAction() function. More...
FORMIT_CORE_EXPORT bool	FormIt::Tools::IsInLayerDelete ()
	IsInLayerDelete() function. More...
FORMIT_CORE_EXPORT void	FormIt::Tools::StartTool (ToolType aType)
FORMIT_CORE_EXPORT void	FormIt::Tools::StartTool (ToolType aType, const utils::AnyDictionary &toolArgs)
	StartTool() function. More...
FORMIT_CORE_EXPORT bool	FormIt::Tools::GetPaintToolMaterial (size_t &materialId)
	Gets the id of the formit material used by the paint tool. More...
FORMIT_CORE_EXPORT void	FormIt::Tools::ClearAllInferences ()
	Clear all inferences. More...

Function Documentation

FORMIT_CORE_EXPORT void FormIt::Tools::ClearAllInferences

(

)

Clear all inferences.

FORMIT_CORE_EXPORT void FormIt::Tools::ClearTools

(

)

Remove active and secondary tools, go back to neutral state.

Note: neutral state has Camera Navigation Tools, KeyboardShortcutTool, and SelectionTool on the stack Returns whether the Clear was performed.

FORMIT_CORE_EXPORT ToolType FormIt::Tools::GetActiveToolSubType

(

)

GetActiveToolSubType() function.

FORMIT_CORE_EXPORT ToolType FormIt::Tools::GetActiveToolType

(

)

GetActiveToolType() function.

FORMIT_CORE_EXPORT bool FormIt::Tools::GetPaintToolMaterial

(

size_t &

materialId

)

Gets the id of the formit material used by the paint tool.

Returns false if the paint tool is not active.

Parameters

[out]

materialId

FORMIT_CORE_EXPORT bool FormIt::Tools::IsInContinuousAction

(

)

IsInContinuousAction() function.

FORMIT_CORE_EXPORT bool FormIt::Tools::IsInLayerDelete

(

)

IsInLayerDelete() function.

FORMIT_CORE_EXPORT void FormIt::Tools::StartTool

(

ToolType

aType

)

FORMIT_CORE_EXPORT void FormIt::Tools::StartTool	(	ToolType	aType,
		const utils::AnyDictionary &	toolArgs
	)

StartTool() function.

Parameters

[in]	aType
[in]	toolArgs