Struct Facing

Controls how visuals are oriented, e.g. the normal/up/facing vector of a circle.

For convenience any of the following can be used directly anywhere a Facing value is expected:

• Any of the FacingMode enums. (Note that can't be valid for Value as this requires explicitly specifying a direction.)
• A float3 or Vector3.
• A float4 or Vector4 with float4.xyz representing the axis and float4.w the rotation.

public struct Facing

Constructors

Facing(FacingMode, float3, float)

public Facing(FacingMode mode, float3 axis, float rotation)

Parameters

mode FacingMode

axis float3

rotation float

Facing(float3, float)

public Facing(float3 axis, float rotation = 0)

Parameters

axis float3

rotation float

Fields

Camera

The facing/up vector will automatically face the camera based on the individual visual's position.

public static readonly Facing Camera

Field Value

Facing

Global

The facing/up vector will be inherited from the global default.

public static readonly Facing Global

Field Value

Facing

axis

public float3 axis

Field Value

float3

mode

public FacingMode mode

Field Value

FacingMode

rotation

The rotation in degrees around axis.

public float rotation

Field Value

float

Methods

GlobalOrCamera()

public static Facing GlobalOrCamera()

Returns

Facing

Resolve(float3)

If mode is Camera, cameraDirection will be returned, otherwise returns the explicitly set direction.

public float3 Resolve(float3 cameraDirection)

Parameters

cameraDirection float3

Returns

float3

SetFrom(Facing)

Handles automatically setting the facing value in the case that from is Global.

public void SetFrom(Facing from)

Parameters

from Facing

ToCamera()

Changes this Facing to Camera, without altering its value.

public void ToCamera()

ToGlobal()

Changes this Facing to Global, without altering its value.

public void ToGlobal()

ToString()

public override string ToString()

Returns

string

ToValue()

Changes this Facing to Value, without altering its value.

public void ToValue()

WithRotation(float)

Returns a copy of this Facing with the given rotation.

public readonly Facing WithRotation(float angle)

Parameters

angle float

Returns

Facing

Operators

implicit operator float3(Facing)

public static implicit operator float3(Facing @this)

Parameters

this Facing

Returns

float3

implicit operator Facing(FacingMode)

public static implicit operator Facing(FacingMode mode)

Parameters

mode FacingMode

Returns

Facing

implicit operator Facing(float3)

public static implicit operator Facing(float3 axis)

Parameters

axis float3

Returns

Facing

implicit operator Facing(float4)

public static implicit operator Facing(float4 axis)

Parameters

axis float4

Returns

Facing

implicit operator Facing(Vector3)

public static implicit operator Facing(Vector3 axis)

Parameters

axis Vector3

Returns

Facing

implicit operator Facing(Vector4)

public static implicit operator Facing(Vector4 axis)

Parameters

axis Vector4

Returns

Facing