GearBlocks
The GearBlocks Lua scripting API
Public Member Functions | Properties | List of all members
SmashHammer.Scripting.ITransformable Interface Reference

A transformable entity. More...

Inheritance diagram for SmashHammer.Scripting.ITransformable:
SmashHammer.GearBlocks.Construction.PartDescriptor SmashHammer.GearBlocks.Player.Player SmashHammer.GearBlocks.Construction.PartDescriptorProcedural

Public Member Functions

Vector3Proxy TransformDirection (Vector3Proxy direction)
 Transforms direction from local space to world space.
 
Vector3Proxy TransformVector (Vector3Proxy vector)
 Transforms vector from local space to world space.
 
Vector3Proxy TransformPoint (Vector3Proxy point)
 Transforms point from local space to world space.
 
Vector3Proxy InverseTransformDirection (Vector3Proxy direction)
 Transforms direction from world space to local space.
 
Vector3Proxy InverseTransformVector (Vector3Proxy vector)
 Transforms vector from world space to local space.
 
Vector3Proxy InverseTransformPoint (Vector3Proxy point)
 Transforms point from world space to local space.
 

Properties

Vector3Proxy Position [get]
 The world position.
 
QuaternionProxy Orientation [get]
 The world orientation.
 
Vector3Proxy LocalPosition [get]
 The local position.
 
QuaternionProxy LocalOrientation [get]
 The local orientation.
 
Vector3Proxy Right [get]
 The right vector.
 
Vector3Proxy Up [get]
 The up vector.
 
Vector3Proxy Forward [get]
 The forward vector.
 

Detailed Description

A transformable entity.

Member Function Documentation

◆ TransformDirection()

Vector3Proxy SmashHammer.Scripting.ITransformable.TransformDirection ( Vector3Proxy  direction)

Transforms direction from local space to world space.

Parameters
directionThe direction to transform.
Returns
The transformed direction.

◆ TransformVector()

Vector3Proxy SmashHammer.Scripting.ITransformable.TransformVector ( Vector3Proxy  vector)

Transforms vector from local space to world space.

Parameters
vectorThe vector to transform.
Returns
The transformed vector.

◆ TransformPoint()

Vector3Proxy SmashHammer.Scripting.ITransformable.TransformPoint ( Vector3Proxy  point)

Transforms point from local space to world space.

Parameters
pointThe point to transform.
Returns
The transformed point.

◆ InverseTransformDirection()

Vector3Proxy SmashHammer.Scripting.ITransformable.InverseTransformDirection ( Vector3Proxy  direction)

Transforms direction from world space to local space.

Parameters
directionThe direction to transform.
Returns
The transformed direction.

◆ InverseTransformVector()

Vector3Proxy SmashHammer.Scripting.ITransformable.InverseTransformVector ( Vector3Proxy  vector)

Transforms vector from world space to local space.

Parameters
vectorThe vector to transform.
Returns
The transformed vector.

◆ InverseTransformPoint()

Vector3Proxy SmashHammer.Scripting.ITransformable.InverseTransformPoint ( Vector3Proxy  point)

Transforms point from world space to local space.

Parameters
pointThe point to transform.
Returns
The transformed point.

Property Documentation

◆ Position

Vector3Proxy SmashHammer.Scripting.ITransformable.Position
get

The world position.

This transform's world position.

◆ Orientation

QuaternionProxy SmashHammer.Scripting.ITransformable.Orientation
get

The world orientation.

This transform's world orientation.

◆ LocalPosition

Vector3Proxy SmashHammer.Scripting.ITransformable.LocalPosition
get

The local position.

This transform's local position.

◆ LocalOrientation

QuaternionProxy SmashHammer.Scripting.ITransformable.LocalOrientation
get

The local orientation.

This transform's local orientation.

◆ Right

Vector3Proxy SmashHammer.Scripting.ITransformable.Right
get

The right vector.

This transform's right vector in world space.

◆ Up

Vector3Proxy SmashHammer.Scripting.ITransformable.Up
get

The up vector.

This transform's up vector in world space.

◆ Forward

Vector3Proxy SmashHammer.Scripting.ITransformable.Forward
get

The forward vector.

This transform's forward vector in world space.