VerticesEngine.vxTransform Class Reference

This is the main transform class which houses an entities scale, position and orientations. More...

Public Member Functions
	vxTransform (Vector3 position)
	vxTransform (Vector3 position, Quaternion rotation)
	vxTransform (Vector3 position, Quaternion rotation, Vector3 scale)
	vxTransform (Matrix matrix4x4Transform)
void	SetTransform (Vector3 position, Quaternion rotation)
	Sets the position and rotation without firing off a transform updated event for each.
void	Rotate (float x, float y, float z)
	Rotates the transform by a given euler angle (in degrees) about x, y and z.
void	Rotate (Vector3 eulerAngles)
	Rotates the transform by a given euler angle (in degrees) about x, y and z.
void	Rotate (Vector3 axis, float angle)
	Rotates the transform about the given axis by the specified number of degrees.
vxTransform	ToCopy ()

Public Attributes
Action	OnTransformUpdated = () => { }

Properties
Vector3	Scale [get, set]
	The scale to apply to this transform.
Vector3	Position [get, set]
	The position of this transform in 3D space.
Quaternion	Rotation [get, set]
	The Rotation Quaternion.
Vector3	Forward [get]
Vector3	Backward [get]
Vector3	Up [get]
Vector3	Down [get]
Vector3	Right [get]
Vector3	Left [get]
Matrix	Matrix4x4Transform [get]
	The 4x4 world matrix which makes up the scale, rotation and position as a single matrix. This is usually passed through to the shaders as the model or world matrix.
RenderPassTransformData	RenderPassData [get]
static vxTransform	Identity [get]
	Returns back a transform as the identity matrix.

Detailed Description

This is the main transform class which houses an entities scale, position and orientations.

Member Function Documentation

Rotate() [1/3]

void VerticesEngine.vxTransform.Rotate	(	float	x,
		float	y,
		float	z )

Rotates the transform by a given euler angle (in degrees) about x, y and z.

Parameters

x	The amount of roll
y	The amount of yaw
z	The amount of pitch

Rotate() [2/3]

void VerticesEngine.vxTransform.Rotate	(	Vector3	axis,
		float	angle )

Rotates the transform about the given axis by the specified number of degrees.

Parameters

axis	The axis to rotate about
angle	The number of Degrees to rotate by

Rotate() [3/3]

void VerticesEngine.vxTransform.Rotate

(

Vector3

eulerAngles

)

Rotates the transform by a given euler angle (in degrees) about x, y and z.

Parameters

eulerAngles

X is roll, Y is yaw and Z it pitch

SetTransform()

void VerticesEngine.vxTransform.SetTransform	(	Vector3	position,
		Quaternion	rotation )

Sets the position and rotation without firing off a transform updated event for each.

Parameters

position
rotation

---

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

• /github/workspace/src/VerticesEngine/src.shared/Graphics/vxTransform.cs