C# Class Forge.Unity.DataRenderer

Base MonoBehavior type that can be used to implement custom data renderers. DataRenderers need to be annotated with a CustomDataRegistry attribute.
Inheritance: UnityEngine.MonoBehaviour
Show file Open project: jacobdufault/forge-unity

Private Properties

Property Type Description

Public Methods

Method Description
Initialize ( IQueryableEntity entity ) : void
UpdateVisualization ( float percentage ) : void

Called when the visualization should be updated. Visualizations are updated continuously, often multiple times between game updates.

Protected Methods

Method Description
Interpolate ( Vector3 start, Vector3 end, float percentage ) : Vector3
Interpolate ( float start, float end, float percentage ) : float
OnDestroy ( ) : void

Called when the DataRenderer has been destroyed by Unity. Removes the DataRenderer from the DataRendererManager.

OnInitialize ( ) : void

Called when the renderer has been initialized. The entity that this renderer will operate on is populated under Entity.

Method Details

Initialize() public method

public Initialize ( IQueryableEntity entity ) : void
entity IQueryableEntity
return void

Interpolate() protected static method

protected static Interpolate ( Vector3 start, Vector3 end, float percentage ) : Vector3
start UnityEngine.Vector3
end UnityEngine.Vector3
percentage float
return UnityEngine.Vector3

Interpolate() protected static method

protected static Interpolate ( float start, float end, float percentage ) : float
start float
end float
percentage float
return float

OnDestroy() protected method

Called when the DataRenderer has been destroyed by Unity. Removes the DataRenderer from the DataRendererManager.
protected OnDestroy ( ) : void
return void

OnInitialize() protected abstract method

Called when the renderer has been initialized. The entity that this renderer will operate on is populated under Entity.
protected abstract OnInitialize ( ) : void
return void

UpdateVisualization() public abstract method

Called when the visualization should be updated. Visualizations are updated continuously, often multiple times between game updates.
public abstract UpdateVisualization ( float percentage ) : void
percentage float The interpolation percentage that should be used between the /// last frame and this frame.
return void