Falco Engine 3.9.0.1 (beta)
FalcoEngine.Transform Class Reference
Inheritance diagram for FalcoEngine.Transform:
FalcoEngine.Component

Public Member Functions

Transform GetChild (int index)
 Returns a transform child by index More...
 
Transform FindChild (string name)
 Finds a child by name and returns it More...
 
Vector3 TransformDirection (Vector3 direction)
 
Vector3 TransformDirection (float x, float y, float z)
 
Vector3 InverseTransformDirection (Vector3 direction)
 
Vector3 InverseTransformDirection (float x, float y, float z)
 
Vector3 TransformPoint (Vector3 position)
 
Vector3 TransformPoint (float x, float y, float z)
 
Vector3 InverseTransformPoint (Vector3 position)
 
Vector3 InverseTransformPoint (float x, float y, float z)
 

Properties

Vector3 position [getset]
 The world space position of the transform More...
 
Quaternion rotation [getset]
 A Quaternion that stores the rotation of the transform in world space More...
 
Vector3 scale [getset]
 The global scale of the object More...
 
Vector3 localPosition [getset]
 Position of the transform relative to the parent transform. More...
 
Quaternion localRotation [getset]
 The rotation of the transform relative to the transform rotation of the parent More...
 
Vector3 localScale [getset]
 The scale of the transform relative to the GameObjects parent. More...
 
Vector3 forward [get]
 Returns a normalized vector representing the blue axis of the transform in world space More...
 
Vector3 up [get]
 The green axis of the transform in world space More...
 
Vector3 left [get]
 The negative red axis of the transform in world space More...
 
Vector3 right [get]
 The red axis of the transform in world space More...
 
int childCount [get]
 The number of children the transform has More...
 
Transform parent [getset]
 The parent of the transform More...
 
- Properties inherited from FalcoEngine.Component
bool enabled [getset]
 Enable or disable this component More...
 
GameObject gameObject [get]
 Get game object at which this component is attached More...
 
bool isUiComponent [get]
 Returns if this component is derived from UIElement (or this is a canvas) or not More...
 

Additional Inherited Members

- Protected Member Functions inherited from FalcoEngine.Component
 Component ()
 

Detailed Description

Definition at line 7 of file Transform.cs.

Member Function Documentation

◆ FindChild()

Transform FalcoEngine.Transform.FindChild ( string  name)

Finds a child by name and returns it

Parameters
name
Returns

Definition at line 187 of file Transform.cs.

◆ GetChild()

Transform FalcoEngine.Transform.GetChild ( int  index)

Returns a transform child by index

Parameters
index
Returns

Definition at line 177 of file Transform.cs.

◆ InverseTransformDirection() [1/2]

Vector3 FalcoEngine.Transform.InverseTransformDirection ( float  x,
float  y,
float  z 
)

Transforms the direction x, y, z from world space to local space. The opposite of Transform.TransformDirection.

Parameters
x
y
z

Definition at line 229 of file Transform.cs.

◆ InverseTransformDirection() [2/2]

Vector3 FalcoEngine.Transform.InverseTransformDirection ( Vector3  direction)

Transforms a direction from world space to local space. The opposite of Transform.TransformDirection.

Parameters
direction

Definition at line 217 of file Transform.cs.

◆ InverseTransformPoint() [1/2]

Vector3 FalcoEngine.Transform.InverseTransformPoint ( float  x,
float  y,
float  z 
)

Transforms the position x, y, z from world space to local space. The opposite of Transform.TransformPoint.

Parameters
x
y
z

Definition at line 271 of file Transform.cs.

◆ InverseTransformPoint() [2/2]

Vector3 FalcoEngine.Transform.InverseTransformPoint ( Vector3  position)

Transforms position from world space to local space.

Parameters
position

Definition at line 259 of file Transform.cs.

◆ TransformDirection() [1/2]

Vector3 FalcoEngine.Transform.TransformDirection ( float  x,
float  y,
float  z 
)

Transforms direction x, y, z from local space to world space.

Parameters
x
y
z

Definition at line 208 of file Transform.cs.

◆ TransformDirection() [2/2]

Vector3 FalcoEngine.Transform.TransformDirection ( Vector3  direction)

Transforms direction from local space to world space.

Parameters
direction

Definition at line 196 of file Transform.cs.

◆ TransformPoint() [1/2]

Vector3 FalcoEngine.Transform.TransformPoint ( float  x,
float  y,
float  z 
)

Transforms the position x, y, z from local space to world space.

Parameters
x
y
z

Definition at line 250 of file Transform.cs.

◆ TransformPoint() [2/2]

Vector3 FalcoEngine.Transform.TransformPoint ( Vector3  position)

Transforms position from local space to world space.

Parameters
position

Definition at line 238 of file Transform.cs.

Property Documentation

◆ childCount

int FalcoEngine.Transform.childCount
get

The number of children the transform has

Definition at line 165 of file Transform.cs.

◆ forward

Vector3 FalcoEngine.Transform.forward
get

Returns a normalized vector representing the blue axis of the transform in world space

Definition at line 117 of file Transform.cs.

◆ left

Vector3 FalcoEngine.Transform.left
get

The negative red axis of the transform in world space

Definition at line 141 of file Transform.cs.

◆ localPosition

Vector3 FalcoEngine.Transform.localPosition
getset

Position of the transform relative to the parent transform.

Definition at line 69 of file Transform.cs.

◆ localRotation

Quaternion FalcoEngine.Transform.localRotation
getset

The rotation of the transform relative to the transform rotation of the parent

Definition at line 85 of file Transform.cs.

◆ localScale

Vector3 FalcoEngine.Transform.localScale
getset

The scale of the transform relative to the GameObjects parent.

Definition at line 101 of file Transform.cs.

◆ parent

Transform FalcoEngine.Transform.parent
getset

The parent of the transform

Definition at line 170 of file Transform.cs.

◆ position

Vector3 FalcoEngine.Transform.position
getset

The world space position of the transform

Definition at line 21 of file Transform.cs.

◆ right

Vector3 FalcoEngine.Transform.right
get

The red axis of the transform in world space

Definition at line 153 of file Transform.cs.

◆ rotation

Quaternion FalcoEngine.Transform.rotation
getset

A Quaternion that stores the rotation of the transform in world space

Definition at line 37 of file Transform.cs.

◆ scale

Vector3 FalcoEngine.Transform.scale
getset

The global scale of the object

Definition at line 53 of file Transform.cs.

◆ up

Vector3 FalcoEngine.Transform.up
get

The green axis of the transform in world space

Definition at line 129 of file Transform.cs.


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