FormIt::Tools API

Description

Functions
FORMIT_CORE_EXPORT void	FormIt::Tools::ClearTools ()
	Remove active and secondary tools, go back to neutral state.
FORMIT_CORE_EXPORT ToolType	FormIt::Tools::GetActiveToolType ()
	GetActiveToolType() function.
FORMIT_CORE_EXPORT ToolType	FormIt::Tools::GetActiveToolSubType ()
	GetActiveToolSubType() function.
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)
	StartTool() function.
FORMIT_CORE_EXPORT void	FormIt::Tools::StartTool (ToolType aType, const json &toolArgs)
FORMIT_CORE_EXPORT bool	FormIt::Tools::GetPaintToolMaterial (size_t &materialId)
	Gets the id of the formit material used by the paint tool.
FORMIT_CORE_EXPORT void	FormIt::Tools::ClearAllInferences ()
	Clear all inferences.
	FormIt::Tools::API_STR_CONST (FormIt.Tools, kUseImplicitToolsFlag)
	Tool feature flags.
	FormIt::Tools::API_STR_CONST (FormIt.Tools, kDoubleClickMeshToObjectFlag)
FORMIT_CORE_EXPORT void	FormIt::Tools::UseImplicitTools (bool bUseImplicitTools)
	Turn implicit tool mode on/off.
FORMIT_CORE_EXPORT bool	FormIt::Tools::UsingImplicitTools ()
	Return tool mode Returns true if in implicit tool mode.

Function Documentation

API_STR_CONST() [1/2]

FormIt::Tools::API_STR_CONST	(	FormIt.	Tools,
		kDoubleClickMeshToObjectFlag
	)

API_STR_CONST() [2/2]

FormIt::Tools::API_STR_CONST	(	FormIt.	Tools,
		kUseImplicitToolsFlag
	)

Tool feature flags.

ClearAllInferences()

FORMIT_CORE_EXPORT void FormIt::Tools::ClearAllInferences

(

)

Clear all inferences.

ClearTools()

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.

GetActiveToolSubType()

FORMIT_CORE_EXPORT ToolType FormIt::Tools::GetActiveToolSubType

(

)

GetActiveToolSubType() function.

GetActiveToolType()

FORMIT_CORE_EXPORT ToolType FormIt::Tools::GetActiveToolType

(

)

GetActiveToolType() function.

GetPaintToolMaterial()

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

IsInContinuousAction()

FORMIT_CORE_EXPORT bool FormIt::Tools::IsInContinuousAction

(

)

IsInContinuousAction() function.

IsInLayerDelete()

FORMIT_CORE_EXPORT bool FormIt::Tools::IsInLayerDelete

(

)

IsInLayerDelete() function.

StartTool() [1/2]

FORMIT_CORE_EXPORT void FormIt::Tools::StartTool

(

ToolType

aType

)

StartTool() function.

Parameters

[in]

aType

StartTool() [2/2]

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

UseImplicitTools()

FORMIT_CORE_EXPORT void FormIt::Tools::UseImplicitTools

(

bool

bUseImplicitTools

)

Turn implicit tool mode on/off.

Parameters

[in]

bUseImplicitTools

UsingImplicitTools()

FORMIT_CORE_EXPORT bool FormIt::Tools::UsingImplicitTools

(

)

Return tool mode Returns true if in implicit tool mode.