BaseSRTTool (object)

Members

Boolean	enabled	Handler is enabled.
Key	enableKey	Enable key.
HandlerExclusivity	handlerExclusivity	Handler exclusivity.
Boolean	isIndependent	HandlerExclusivity local override.
Boolean	takeAllEvents	It true, the handler takes all the events.
Boolean	alwaysEnabled	It true, the handler takes all the events.
Boolean	isOwnedByDispatcher	Checks if the handler is owned by a handlerDispatcher. In most of the cases, the dispatcher owns the handlers. However, it’s not true in DFG graphs where the handlers are owns by the nodes.
Ref<HandlerDispatcher>	dispatcher	Reference to the dispatcher.
ToolTarget	target	Tool target.
Boolean	performing	True if the tool is performing an action.
Mat44	transform	Tool transform (SRT).
Mat44	transformNoScaling	Tool transform with no scaling (RT).
Vec3	scalingDelta	Accumulated scaling delta while performing (for manip drawing prupose only).
Vec3	currentAxis	Current manipulation axis (local).
ManipulationMode	mode	Mode determining which gizmos are currently visible.

Methods

	BaseSRTTool ( in BaseSRTTool other )
	BaseSRTTool ()
Ray	castRay ? ( io MouseEvent mouseEvent )
BaseSRTTool	clone ? ()
	enable ! ()
HandlerDescription	getDescription ? ()
Key	getManipulationModeKey ? ( in ManipulationMode mode )
Vec3	getScalingDelta ? ()
Boolean	hasKey ? ( in Key key )
	init ! ( in SRTTarget target, in Key scaleKey, in Key rotateKey, in Key translateKey, in Key enableKey, in HandlerExclusivity exclusivity, in Boolean isOwnedByDispatcher )
	move ! ( io MouseEvent mouseEvent )
	onEvent ! ( io Event event )
	press ! ( io MouseEvent mouseEvent )
	release ! ( io MouseEvent mouseEvent )
	setManipulationModeKey ! ( in ManipulationMode mode, in Key key )
	transformChanged ! ( in Mat44 transform )
	updateFromTarget ! ()

Methods in detail

BaseSRTTool ( in BaseSRTTool other )

copy constructor

---

BaseSRTTool ()

default constructor

---

Ray BaseSRTTool.castRay? ( io MouseEvent mouseEvent )

Implementation of SRTTool To override.

---

BaseSRTTool BaseSRTTool.clone? ()

clone method

---

BaseSRTTool.enable! ()

Implementation of EventHandler.

---

HandlerDescription BaseSRTTool.getDescription? ()

Implementation of EventHandler.

---

Key BaseSRTTool.getManipulationModeKey? ( in ManipulationMode mode )

Gets the key for this manipulation mode.

mode	Manipulation mode.

---

Vec3 BaseSRTTool.getScalingDelta? ()

Gets the scaling delta.

---

Boolean BaseSRTTool.hasKey? ( in Key key )

Implementation of EventHandler.

---

BaseSRTTool.init! ( in SRTTarget target, in Key scaleKey, in Key rotateKey, in Key translateKey, in Key enableKey, in HandlerExclusivity exclusivity, in Boolean isOwnedByDispatcher )

Constructs a BaseSRTTool.

target	Tool target
scaleKey	Key to activate the scale mode.
rotateKey	Key to activate the orientation mode.
translateKey	Key to activate the posititon mode.
enableKey	Key to enable to tool
exclusivity	Handler exclusivity.
isOwnedByDispatcher	If true, the handler is owned by the dispatcher.

---

BaseSRTTool.move! ( io MouseEvent mouseEvent )

Implementation of Tool.

---

BaseSRTTool.onEvent! ( io Event event )

Implementation of EventHandler.

---

BaseSRTTool.press! ( io MouseEvent mouseEvent )

Implementation of Tool.

---

BaseSRTTool.release! ( io MouseEvent mouseEvent )

Implementation of Tool.

---

BaseSRTTool.setManipulationModeKey! ( in ManipulationMode mode, in Key key )

Sets the key for this manipulation mode.

mode	Manipulation mode.
key	Key to activate the mode.

---

BaseSRTTool.transformChanged! ( in Mat44 transform )

Implementation of SRTTool Can be overridden. We set the scale to one in order to not scaled up/dowm the gizmo drawing

---

BaseSRTTool.updateFromTarget! ()

Implementation of Tool. Can be overridden.