PathVisualizer Class

Namespace
RedGirafeGames.Agamotto.Scripts.Runtime.Visualizers
Base Types
graph BT Type-->Base0["AbstractTimeVisualizer"] click Base0 "/api/RedGirafeGames.Agamotto.Scripts.Runtime.Visualizers/AbstractTimeVisualizer" Base0-->Base1["MonoBehaviour"] Type["PathVisualizer"] class Type type-node

Syntax

[AddComponentMenu("Agamotto/Path Visualizer")]
[RequireComponent(typeof(LineRenderer))]
public class PathVisualizer : AbstractTimeVisualizer

Attributes

Type Description
AddComponentMenu
RequireComponent

Fields

Name Constant Value Summary
autoAssignStone
Automatically assigns the stone from the first stone interacting with the timeAgent
Inherited from AbstractTimeVisualizer
autoUpdateOnSimulationComplete
The visualizer listens to OnSimulationComplete() UnityEvent to update wen received.
Inherited from AbstractTimeVisualizer
autoUpdateOnTimeLineChange
The visualizer listens to OnTimeLineChange(TimeStone.TimeTickOrigin) UnityEvent to update when received. This is mostly used to update during a recording
Inherited from AbstractTimeVisualizer
dynamicSimplifyTolerance
Tolerance for LineRenderer.Simplify calls during PathVisualizer dynamic updates (timeLine change) This value should be lower than simplifyTolerance because the simplification will be made while the line is created, therefore the "breaking" point could be simplified while it shouldn't
lineRenderer
The LineRenderer displaying the path, each point correspond to a tick in the TimeStone's TimeLine
logDebug
Log all messages
Inherited from AbstractTimeVisualizer
pointsOffset
Offset applied to each point, useful to display the line above the ground if the TimeAgent origin is at ground level for example.
simplifyTolerance
Tolerance for LineRenderer.Simplify calls during PathVisualizer update 0 = same line, higher value = better perf and less precision. See LineRenderer documentation for more details
stone
The TimeStone visualized.

Unlike TimeAgent, a visualizer can only be used by one stone.

Inherited from AbstractTimeVisualizer
timeAgent
The timeAgent. Should be present on the GameObject and will be automatically populated
Inherited from AbstractTimeVisualizer
visualizationEnabled
Flag to know if the visualization must be visible. It will be set to false if critical data are missing, like the timeAgent or the timeStone for example.
Inherited from AbstractTimeVisualizer

Methods

Name Value Summary
AddPointsSinceLastChange() void
AddStoneListeners() void
Add listeners to the TimeStone
Inherited from AbstractTimeVisualizer
Awake() void
Inherited from AbstractTimeVisualizer
ClearVisualization(int) void
OnInitTimeAgentsList() void
Callback to TimeStone's event InitTimeAgentsList
Inherited from AbstractTimeVisualizer
OnRecordStart() void
Callback to TimeStone's event OnRecordStop
Inherited from AbstractTimeVisualizer
OnRecordStop() void
OnSimulationComplete() void
OnSimulationStart() void
OnStoneInitTimeAgentsList(TimeStone) void
OnTimeAgentSetDataTick(TimeStone, int) void
Callback to TimeAgent's event OnSetDataTick Can be useful if the visualizer is dependent to the current tick. See OnionSkinVisualizer for example.
Inherited from AbstractTimeVisualizer
OnTimeLineChange(TimeStone.TimeTickOrigin) void
OnTimeLineClear() void
RemoveStoneListeners() void
Remove listeners from the TimeStone
Inherited from AbstractTimeVisualizer
TryDisableClone() void
UpdateVisualization() void
UpdateVisualizationStatus() void
Sets flag visualizationEnabled in case the visualizer misses a critical data to be displayed. This flag must be used in the Component extending AbstractTimeVisualizer
Inherited from AbstractTimeVisualizer