TransformGizmo
@zylem/game-lib / debug / TransformGizmo
Class: TransformGizmo
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:171
Constructors
Constructor
new TransformGizmo():
TransformGizmo
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:193
Returns
TransformGizmo
Properties
root
readonlyroot:Group<Object3DEventMap>
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:173
Root added to the scene; carries the pivot transform.
Accessors
draggingAxis
Get Signature
get draggingAxis():
GizmoAxis|null
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:455
Returns
GizmoAxis | null
isDragging
Get Signature
get isDragging():
boolean
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:451
Returns
boolean
pivot
Get Signature
get pivot():
Vector3
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:257
Returns
Vector3
visible
Get Signature
get visible():
boolean
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:253
Returns
boolean
Methods
addTo()
addTo(
scene):void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:210
Parameters
scene
Scene
Returns
void
beginDrag()
beginDrag(
axis,ray,camera):boolean
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:361
Begin a drag on a handle.
Parameters
axis
ray
camera
Camera
Returns
boolean
false when the gesture cannot be tracked (a near-parallel view
of the drag axis), so the caller can ignore the press rather than start a
drag that would jump.
dispose()
dispose():
void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:222
Returns
void
endDrag()
endDrag():
void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:446
Returns
void
getMode()
getMode():
GizmoMode
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:238
Returns
hide()
hide():
void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:248
Returns
void
pick()
pick(
ray):GizmoAxis|null
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:299
Which handle a ray hits, or null.
Raycasts the gizmo's own meshes rather than the physics world. Handles are render-only objects with no colliders, so the physics raycast used to pick entities cannot see them at all.
Parameters
ray
Returns
GizmoAxis | null
removeFromScene()
removeFromScene():
void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:216
Returns
void
setHighlight()
setHighlight(
axis):void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:337
Tint a handle to show it is hovered or being dragged.
Parameters
axis
GizmoAxis | null
Returns
void
setMode()
setMode(
mode):void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:232
Parameters
mode
Returns
void
show()
show(
pivot):void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:243
Place the gizmo at a pivot and show it.
Parameters
pivot
Vector3
Returns
void
update()
update(
camera):void
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:267
Keep the gizmo a constant size on screen.
A world-sized gizmo is unusable in an orbit view: it fills the screen up close and disappears from a distance.
Parameters
camera
Camera
Returns
void
updateDrag()
updateDrag(
ray,camera):GizmoDelta|null
Defined in: packages/game-lib/src/lib/debug/transform-gizmo.ts:398
Raw delta for the current pointer position, or null when unusable.
Parameters
ray
camera
Camera
Returns
GizmoDelta | null