API reference

TurnArrowVisuals Class

Extends MonoBehaviour
This visuals component renders one curved arrow to the left, and another one to the right.
Using the Visual parameters one can control the angle, spacing, curvature, thickness of the arrows. Using the controllers one can highlight one or the other arrow, make them grow or move along their trail.

Protected Fields

_started : bool
Signature
bool _started

Properties

DisabledColor : Color
[Get][Set]
Signature
Color DisabledColor
EnabledColor : Color
[Get][Set]
Signature
Color EnabledColor
FollowArrow : bool
[Get][Set]
Signature
bool FollowArrow
HighLight : bool
[Get][Set]
Signature
bool HighLight
HighligtedColor : Color
[Get][Set]
Signature
Color HighligtedColor
Margin : float
[Get]
Signature
float Margin
MaxAngle : float
[Get]
Signature
float MaxAngle
Progress : float
[Get][Set]
Signature
float Progress
Radius : float
[Get]
Signature
float Radius
RailGap : float
[Get]
Signature
float RailGap
SqueezeLength : float
[Get]
Signature
float SqueezeLength
TrailLength : float
[Get]
Signature
float TrailLength
Value : float
[Get][Set]
Signature
float Value

Protected Methods

OnDisable ()
Signature
virtual void OnDisable()
Returns
void
Start ()
Signature
virtual void Start()
Returns
void

Methods

DisableVisuals ()
Disables all the visual renderers.
Signature
void DisableVisuals()
Returns
void
InjectAllTurnArrowVisuals ( leftArrow , rightArrow , leftRail , rightRail , leftTrail , rightTrail , leftMaterialBlock , rightMaterialBlock , radius , margin , trailLength , maxAngle , railGap , squeezeLength )
Signature
void InjectAllTurnArrowVisuals(Renderer leftArrow, Renderer rightArrow, TubeRenderer leftRail, TubeRenderer rightRail, TubeRenderer leftTrail, TubeRenderer rightTrail, MaterialPropertyBlockEditor leftMaterialBlock, MaterialPropertyBlockEditor rightMaterialBlock, float radius, float margin, float trailLength, float maxAngle, float railGap, float squeezeLength)
Parameters
leftArrow: Renderer
rightArrow: Renderer
leftRail: TubeRenderer
rightRail: TubeRenderer
leftTrail: TubeRenderer
rightTrail: TubeRenderer
leftMaterialBlock: MaterialPropertyBlockEditor
rightMaterialBlock: MaterialPropertyBlockEditor
radius: float
margin: float
trailLength: float
maxAngle: float
railGap: float
squeezeLength: float
Returns
void
InjectLeftArrow ( leftArrow )
Signature
void InjectLeftArrow(Renderer leftArrow)
Parameters
leftArrow: Renderer
Returns
void
InjectLeftMaterialBlock ( leftMaterialBlock )
Signature
void InjectLeftMaterialBlock(MaterialPropertyBlockEditor leftMaterialBlock)
Parameters
leftMaterialBlock: MaterialPropertyBlockEditor
Returns
void
InjectLeftRail ( leftRail )
Signature
void InjectLeftRail(TubeRenderer leftRail)
Parameters
leftRail: TubeRenderer
Returns
void
InjectLeftTrail ( leftTrail )
Signature
void InjectLeftTrail(TubeRenderer leftTrail)
Parameters
leftTrail: TubeRenderer
Returns
void
InjectMargin ( margin )
Signature
void InjectMargin(float margin)
Parameters
margin: float
Returns
void
InjectMaxAngle ( maxAngle )
Signature
void InjectMaxAngle(float maxAngle)
Parameters
maxAngle: float
Returns
void
InjectRadius ( radius )
Signature
void InjectRadius(float radius)
Parameters
radius: float
Returns
void
InjectRailGap ( railGap )
Signature
void InjectRailGap(float railGap)
Parameters
railGap: float
Returns
void
InjectRightArrow ( rightArrow )
Signature
void InjectRightArrow(Renderer rightArrow)
Parameters
rightArrow: Renderer
Returns
void
InjectRightMaterialBlock ( rightMaterialBlock )
Signature
void InjectRightMaterialBlock(MaterialPropertyBlockEditor rightMaterialBlock)
Parameters
rightMaterialBlock: MaterialPropertyBlockEditor
Returns
void
InjectRightRail ( rightRail )
Signature
void InjectRightRail(TubeRenderer rightRail)
Parameters
rightRail: TubeRenderer
Returns
void
InjectRightTrail ( rightTrail )
Signature
void InjectRightTrail(TubeRenderer rightTrail)
Parameters
rightTrail: TubeRenderer
Returns
void
InjectSqueezeLength ( squeezeLength )
Signature
void InjectSqueezeLength(float squeezeLength)
Parameters
squeezeLength: float
Returns
void
InjectTrailLength ( trailLength )
Signature
void InjectTrailLength(float trailLength)
Parameters
trailLength: float
Returns
void
UpdateVisual ()
Updates the Arrows and Colors with the provided Values.
It also re-enables the renderers so they are instantly drawn.
Signature
void UpdateVisual()
Returns
void