Class ArrowExtensions

public static class ArrowExtensions

Inheritance

object

ArrowExtensions

Methods

Color(ref Arrow, Color?)

Set the color for this Arrow.

public static ref Arrow Color(this ref Arrow @this, Color? color)

Parameters

this Arrow

color Color?

Returns

Arrow

Color(ref Arrow, Color?, Color?)

Set the color for this Arrow.

public static ref Arrow Color(this ref Arrow @this, Color? color1, Color? color2)

Parameters

this Arrow

color1 Color?

color2 Color?

Returns

Arrow

FaceCamera(ref Arrow)

Make the visual always face the camera.

public static ref Arrow FaceCamera(this ref Arrow @this)

Parameters

this Arrow

Returns

Arrow

Facing(ref Arrow, Facing)

If non-null the arrow head will be perpendicular to this direction.
Otherwise, the head will face the camera.

public static ref Arrow Facing(this ref Arrow @this, Facing facing)

Parameters

this Arrow

facing Facing

Returns

Arrow

Foot(ref Arrow, ArrowHeadData)

If set will also render a head at the start of the arrow.

public static ref Arrow Foot(this ref Arrow @this, ArrowHeadData foot)

Parameters

this Arrow

foot ArrowHeadData

Returns

Arrow

FootLength(ref Arrow, Size)

The length (along the arrow's direction) of the arrow head.

public static ref Arrow FootLength(this ref Arrow @this, Size length)

Parameters

this Arrow

length Size

Returns

Arrow

FootOffset(ref Arrow, Size)

Offsets the end point away from the desired position along the arrow's direction.

public static ref Arrow FootOffset(this ref Arrow @this, Size offset)

Parameters

this Arrow

offset Size

Returns

Arrow

FootShape(ref Arrow, ArrowHeadShape)

If true, the head will form a closed triangle.

public static ref Arrow FootShape(this ref Arrow @this, ArrowHeadShape shape)

Parameters

this Arrow

shape ArrowHeadShape

Returns

Arrow

FootSize(ref Arrow, Size)

Sets the foot size.

public static ref Arrow FootSize(this ref Arrow @this, Size size)

Parameters

this Arrow

size Size

Returns

Arrow

FootSize(ref Arrow, Size, Size)

Sets the foot size.

public static ref Arrow FootSize(this ref Arrow @this, Size width, Size length)

Parameters

this Arrow

width Size

length Size

Returns

Arrow

FootVisualOffset(ref Arrow, Size)

Offsets this head visual from the end point along the arrow's direction.
Unlike offset, this only offsets the head's visuals, while the arrow's body/line's position will stay the same.

public static ref Arrow FootVisualOffset(this ref Arrow @this, Size visualOffset)

Parameters

this Arrow

visualOffset Size

Returns

Arrow

FootWidth(ref Arrow, Size)

The width (perpendicular to the arrow's direction) of the arrow head.

public static ref Arrow FootWidth(this ref Arrow @this, Size width)

Parameters

this Arrow

width Size

Returns

Arrow

Head(ref Arrow, ArrowHeadData)

Options for how the arrow head is rendered.

public static ref Arrow Head(this ref Arrow @this, ArrowHeadData head)

Parameters

this Arrow

head ArrowHeadData

Returns

Arrow

HeadLength(ref Arrow, Size)

The length (along the arrow's direction) of the arrow head.

public static ref Arrow HeadLength(this ref Arrow @this, Size length)

Parameters

this Arrow

length Size

Returns

Arrow

HeadOffset(ref Arrow, Size)

Offsets the end point away from the desired position along the arrow's direction.

public static ref Arrow HeadOffset(this ref Arrow @this, Size offset)

Parameters

this Arrow

offset Size

Returns

Arrow

HeadShape(ref Arrow, ArrowHeadShape)

If true, the head will form a closed triangle.

public static ref Arrow HeadShape(this ref Arrow @this, ArrowHeadShape shape)

Parameters

this Arrow

shape ArrowHeadShape

Returns

Arrow

HeadSize(ref Arrow, Size)

Sets the head size.

public static ref Arrow HeadSize(this ref Arrow @this, Size size)

Parameters

this Arrow

size Size

Returns

Arrow

HeadSize(ref Arrow, Size, Size)

Sets the head size.

public static ref Arrow HeadSize(this ref Arrow @this, Size width, Size length)

Parameters

this Arrow

width Size

length Size

Returns

Arrow

HeadVisualOffset(ref Arrow, Size)

Offsets this head visual from the end point along the arrow's direction.
Unlike offset, this only offsets the head's visuals, while the arrow's body/line's position will stay the same.

public static ref Arrow HeadVisualOffset(this ref Arrow @this, Size visualOffset)

Parameters

this Arrow

visualOffset Size

Returns

Arrow

HeadWidth(ref Arrow, Size)

The width (perpendicular to the arrow's direction) of the arrow head.

public static ref Arrow HeadWidth(this ref Arrow @this, Size width)

Parameters

this Arrow

width Size

Returns

Arrow

Length(ref Arrow, MinMax)

Limits the length of th arrow, making sure it's always at least min long, and never longer than max.
Use negative values to indicate no limit.

public static ref Arrow Length(this ref Arrow @this, MinMax length)

Parameters

this Arrow

length MinMax

Returns

Arrow

Length(ref Arrow, float)

Set a fixed length for this Arrow.

public static ref Arrow Length(this ref Arrow @this, float length)

Parameters

this Arrow

length float

Returns

Arrow

Length(ref Arrow, float, float)

Limits the length of th arrow, making sure it's always at least min long, and never longer than max.
Use negative values to indicate no limit.

public static ref Arrow Length(this ref Arrow @this, float min, float max)

Parameters

this Arrow

min float

max float

Returns

Arrow

MaxLength(ref Arrow, float)

Set a maximum length for this Arrow.

public static ref Arrow MaxLength(this ref Arrow @this, float length)

Parameters

this Arrow

length float

Returns

Arrow

MinLength(ref Arrow, float)

Set a minimum length for this Arrow.

public static ref Arrow MinLength(this ref Arrow @this, float length)

Parameters

this Arrow

length float

Returns

Arrow

Position(ref Arrow, float3, float3)

Set the position for this Arrow.

public static ref Arrow Position(this ref Arrow @this, float3 p1, float3 p2)

Parameters

this Arrow

p1 float3

p2 float3

Returns

Arrow

Ref(Arrow)

Returns a reference to the previously created Arrow visual.
If you need to keep a reference to a long-lived visual, this will allow you to modify or delete the visual at some point in the future.

Important: only use this directly after creating a visual, as it may not be valid beyond that.

public static VisualRef<Arrow> Ref(this Arrow @this)

Parameters

this Arrow

Returns

VisualRef<Arrow>

Rotation(ref Arrow, float)

Sets the facing rotation an degrees.

public static ref Arrow Rotation(this ref Arrow @this, float rotation)

Parameters

this Arrow

rotation float

Returns

Arrow

SetDefault(ref Arrow)

public static ref Arrow SetDefault(this ref Arrow @this)

Parameters

this Arrow

Returns

Arrow

SetDefault2(ref Arrow)

public static ref Arrow SetDefault2(this ref Arrow @this)

Parameters

this Arrow

Returns

Arrow