GizmoApi Class Reference

Private Member Functions
proto GizmoHandle	GetCount ()
proto Class	GetInstance (GizmoHandle index)
proto Managed	GetTracker (GizmoHandle index)
proto GizmoHandle	FindByTracker (Managed tracker)
proto void	DeselectTracker (Managed tracker)
proto void	Deselect (GizmoHandle index)
proto void	DeselectAll ()
proto void	SelectObject (Object object)
proto void	SelectPhysics (Physics physics)
proto void	SelectUser (Managed instance)
proto void	SetTransformMode (GizmoTransformMode mode)
proto GizmoTransformMode	GetTransformMode ()
proto void	SetSpaceMode (GizmoSpaceMode mode)
proto GizmoSpaceMode	GetSpaceMode ()

Detailed Description

API for managing gizmos

Member Function Documentation

Deselect()

proto void Deselect ( GizmoHandle  index )

private

Deselect the gizmo for the temporary handle

DeselectAll()

proto void DeselectAll ( )

private

Deselect all gizmos

DeselectTracker()

proto void DeselectTracker ( Managed  tracker )

private

Deselect the gizmo for the given tracker

FindByTracker()

proto GizmoHandle FindByTracker ( Managed  tracker )

private

Returns a temporary handle

GetCount()

proto GizmoHandle GetCount ( )

private

Return the number of gizmos

GetInstance()

proto Class GetInstance ( GizmoHandle  index )

private

Return the instance passed in for the temporary handle

GetSpaceMode()

proto GizmoSpaceMode GetSpaceMode ( )

private

Get current space mode for all gizmos

Referenced by CGame::OnKeyPress().

GetTracker()

proto Managed GetTracker ( GizmoHandle  index )

private

Return the tracker passed in for the temporary handle

GetTransformMode()

proto GizmoTransformMode GetTransformMode ( )

private

Get current transform mode for all gizmos

Referenced by CGame::OnKeyPress().

SelectObject()

proto void SelectObject ( Object  object )

private

Sets the transform of the object directly. Internally functions similiar to 'SelectUser'

Tracker: The tracker is the same object

Referenced by Building::OnAction(), OnAction(), EntityAI::OnAction(), InventoryItem::OnAction(), and ManBase::OnAction().

SelectPhysics()

proto void SelectPhysics ( Physics  physics )

private

Applies impulses to set the position when dynamic, otherwise sets the transform in the physics scene. Doesn't work in multiplayer

Tracker: The tracker is the parent entity

Note: Currently, GizmoGetInstance doesn't work due to Script Error: 'Physics' can't be compared against 'Class'

Referenced by OnAction(), EntityAI::OnAction(), InventoryItem::OnAction(), and ManBase::OnAction().

SelectUser()

proto void SelectUser ( Managed  instance )

private

Scripted controls, requires the following methods to be implemented in the class void Gizmo_SetWorldTransform(vector[4] transform, bool finalize) void Gizmo_GetWorldTransform(vector[4] transform) bool Gizmo_IsAllowedTransformMode(GizmoTransformMode mode) bool Gizmo_IsAllowedSpaceMode(GizmoSpaceMode mode)

Tracker: The tracker is the same instance

SetSpaceMode()

proto void SetSpaceMode ( GizmoSpaceMode  mode )

private

Set current space mode for all gizmos

'Gizmo_IsAllowedSpaceMode' function will override the space mode per gizmo to NONE if returned false

Referenced by CGame::OnKeyPress().

SetTransformMode()

proto void SetTransformMode ( GizmoTransformMode  mode )

private

Set current transform mode for all gizmos

'Gizmo_IsAllowedTransformMode' function will override the transform mode per gizmo to NONE if returned false

Referenced by CGame::OnKeyPress().

---

The documentation for this class was generated from the following file:

• P:/scripts/3_Game/Global/GizmoApi.c