FastLineRenderer Class |
Inheritance HierarchyNamespace: DigitalRuby.FastLineRenderer
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe FastLineRenderer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FastLineRenderer | Initializes a new instance of the FastLineRenderer class |
Properties| Name | Description | |
|---|---|---|
 | animation | Obsolete. The Animation attached to this GameObject. (Null if there is none attached). |
| audio | Obsolete. The AudioSource attached to this GameObject. (Null if there is none attached). |
| camera | Obsolete. The Camera attached to this GameObject. (Null if there is none attached). |
| collider | Obsolete. The Collider attached to this GameObject. (Null if there is none attached). |
| collider2D | Obsolete. The Collider2D component attached to the object. |
| constantForce | Obsolete. The ConstantForce attached to this GameObject. (Null if there is none attached). |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| gameObject | The game object this component is attached to. A component is always attached to a game object. |
| guiElement | Obsolete. (Inherited from Component.) |
| guiText | Obsolete. The GUIText attached to this GameObject. (Null if there is none attached). |
| guiTexture | Obsolete. The GUITexture attached to this GameObject (Read Only). (null if there is none attached). |
| hideFlags | Should the object be hidden, saved with the scene or modifiable by the user? |
| hingeJoint | Obsolete. The HingeJoint attached to this GameObject. (Null if there is none attached). |
| isActiveAndEnabled | Has the Behaviour had enabled called. |
| light | Obsolete. The Light attached to this GameObject. (Null if there is none attached). |
| Mesh |
Get or set the mesh that this fast line renderer is using, or null if no mesh is being used yet. If getting a mesh, you must call Apply first, which will create the mesh.
Setting the mesh will clear the fast line renderer first.
|
| name | The name of the object. |
| networkView | Obsolete. The NetworkView attached to this GameObject (Read Only). (null if there is none attached). |
| particleEmitter | Obsolete. The ParticleEmitter attached to this GameObject. (Null if there is none attached). |
| particleSystem | Obsolete. The ParticleSystem attached to this GameObject. (Null if there is none attached). |
| renderer | Obsolete. The Renderer attached to this GameObject. (Null if there is none attached). |
| rigidbody | Obsolete. The Rigidbody attached to this GameObject. (Null if there is none attached). |
| rigidbody2D | Obsolete. The Rigidbody2D that is attached to the Component's GameObject. |
| runInEditMode | Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor). |
| tag | The tag of this game object. |
| transform | The Transform attached to this GameObject. |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
Methods| Name | Description | |
|---|---|---|
| AddLine(FastLineRendererProperties, Boolean, Boolean) |
Adds an individual line that is not meant to be joined to other lines
|
| AddLine(FastLineRendererProperties, IListVector3, ActionFastLineRendererProperties, Boolean, Boolean) |
Adds a line that starts at the first point in the list and ends at the last point of the list
|
| AddLines |
Add distinct line segments from a list. The list must contain start and end points, repeating for each segment.
|
| AppendArc |
Append an arc to the fast line renderer
|
| AppendCircle |
Append a circle to the fast line renderer
|
| AppendCurve |
Append a quad/bezier curve to the fast line renderer. The line curves from props.Start to props.End, using the two control points to curve.
|
| AppendGrid |
Append a grid
|
| AppendLine |
Append a line - End value of props is ignored, use Start field instead.
|
| AppendSpline |
Append a spline to the fast line renderer. Start and End in props is ignored.
|
| Apply |
Apply all line creations
|
| Apply(Boolean) | Obsolete.
Obslete. Use apply without a parameter. Mesh optimization is no longer needed as of Unity 5.5.
|
| BroadcastMessage(String) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| CanAddLines |
Determines if lineCount lines can be added without creating a new mesh
|
| CancelInvoke | Cancels all Invoke calls on this MonoBehaviour. |
| CancelInvoke(String) | Cancels all Invoke calls with name methodName on this behaviour. |
| ChangePosition |
Changes the position of a single line segment.
This method does not support join styles.
You must call Apply to make the changes permanent.
Error will happen if index is out of range.
|
| CompareTag | Is this game object tagged with tag ? |
| CopyTo |
Copy the properties of this fast line renderer to another fast line renderer
|
 | CreateWithParent |
Create a new FastLineRenderer or retrieve from cache if available
|
| EndLine |
Ends a line. use Start on props to specify the end point. Set LineType to EndCap to cap.
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetComponent(Type) | Returns the component of Type type if the game object has one attached, null if it doesn't. |
| GetComponent(String) | Returns the component with name type if the game object has one attached, null if it doesn't. |
| GetComponent``1 | (Inherited from Component.) |
| GetComponentInChildren(Type) | Returns the component of Type type in the GameObject or any of its children using depth first search. |
| GetComponentInChildren(Type, Boolean) | (Inherited from Component.) |
| GetComponentInChildren``1 | (Inherited from Component.) |
| GetComponentInChildren``1(Boolean) | (Inherited from Component.) |
| GetComponentInParent(Type) | Returns the component of Type type in the GameObject or any of its parents. |
| GetComponentInParent``1 | (Inherited from Component.) |
| GetComponents(Type) | Returns all components of Type type in the GameObject. |
| GetComponents(Type, ListComponent) | (Inherited from Component.) |
| GetComponents``1 | (Inherited from Component.) |
| GetComponents``1(ListUMP) | (Inherited from Component.) |
| GetComponentsInChildren(Type) | Returns all components of Type type in the GameObject or any of its children. |
| GetComponentsInChildren(Type, Boolean) | Returns all components of Type type in the GameObject or any of its children. |
| GetComponentsInChildren``1 | (Inherited from Component.) |
| GetComponentsInChildren``1(Boolean) | (Inherited from Component.) |
| GetComponentsInChildren``1(ListUMP) | (Inherited from Component.) |
| GetComponentsInChildren``1(Boolean, ListUMP) | (Inherited from Component.) |
| GetComponentsInParent(Type) | (Inherited from Component.) |
| GetComponentsInParent(Type, Boolean) | Returns all components of Type type in the GameObject or any of its parents. |
| GetComponentsInParent``1 | (Inherited from Component.) |
| GetComponentsInParent``1(Boolean) | (Inherited from Component.) |
| GetComponentsInParent``1(Boolean, ListUMP) | (Inherited from Component.) |
| GetHashCode | (Inherited from Object.) |
| GetInstanceID | Returns the instance id of the object. |
| GetType | (Inherited from Object.) |
| Invoke | Invokes the method methodName in time seconds. |
| InvokeRepeating | Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds. |
| IsInvoking | Is any invoke pending on this MonoBehaviour? |
| IsInvoking(String) | Is any invoke on methodName pending? |
| MemberwiseClone | (Inherited from Object.) |
| Reset |
Reset everything, remove all lines
|
| ResetAll |
Reset all FastLineRenderer objects in the scene - this is fast and does not rely on the slow Unity Find* methods.
|
| SendMessage(String) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessageUpwards(String) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendToCache |
Reset and then add this FastLineRenderer to the cache
|
| SendToCacheAfter |
Send this FastLineRenderer back to the cache after a certain time
|
| SetCapacity |
Set the capacity of all internal lists.
|
| StartCoroutine(IEnumerator) | Starts a coroutine. |
| StartCoroutine(String) | Starts a coroutine named methodName. |
| StartCoroutine(String, Object) | Starts a coroutine named methodName. |
| StartCoroutine_Auto | Obsolete. (Inherited from MonoBehaviour.) |
| StartLine |
Start a line. Start and End must be set on the properties. Set LineType to StartCap to cap.
|
| StopAllCoroutines | Stops all coroutines running on this behaviour. |
| StopCoroutine(String) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| StopCoroutine(IEnumerator) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| StopCoroutine(Coroutine) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| ToString | Returns the name of the GameObject. |
Fields| Name | Description | |
|---|---|---|
 | AnimationSpeed |
Animation speed. Used for marching ants style animation.
|
| BoundsScale |
Amount to scale the mesh by. If you aren't using GPU properties that modify position (i.e. turbulence, velocity and angular velocity) you can leave as 1.
If you are using GPU properties, you will want to assign a value that is large enough to scale the mesh size so that vertices are visible for the lifetime of the lines.
|
| Camera |
Camera. Defaults to main camera.
|
| EndCapScale |
Scale for end caps.
|
| GlowAnimationSpeed |
Glow animation speed. Used for marching ants style animation.
|
| GlowColor |
Glow color. Applies globally in the Material rather than per vertex.
|
| GlowIntensityMultiplier |
Glow itensity multiplier. Applies globally in the Material rather than per vertex. Set to 0 for no glow.
|
| GlowLengthMultiplier |
Glow length multiplier. Applies globally in the Material rather than per vertex.
|
| GlowTexture |
Glow texture
|
| GlowTextureEndCap |
Glow texture - end cap
|
| GlowTextureRoundJoin |
Glow texture - round join
|
| GlowTextureStartCap |
Glow texture - start cap
|
| GlowUVXScale |
Line glow UV X Scale. If not 1, Ensure your material glow texture is set to repeat. Applies globally in the Material rather than per vertex.
|
| GlowUVYScale |
Line glow UV Y Scale. IF not 1, Ensure your material glow texture is set to repeat. Applies globally in the Material rather than per vertex.
|
| GlowWidthMultiplier |
Glow width multiplier. Applies globally in the Material rather than per vertex.
|
| InitialLineGroups |
Initial set of lines. Leave empty if you are generating your lines in script.
|
| JitterMultiplier |
Jitter multiplier. Applies globally in the Material rather than per vertex.
|
| LineTexture |
Line texture
|
| LineTextureEndCap |
Line texture - end cap
|
| LineTextureRoundJoin |
Line texture - round join
|
| LineTextureStartCap |
Line texture - start cap
|
| LineUVXScale |
Line UV X Scale. If not 1, Ensure your material texture is set to repeat. Applies globally in the Material rather than per vertex.
|
| LineUVYScale |
Line UV Y Scale. If not 1, Ensure your material texture is set to repeat. Applies globally in the Material rather than per vertex.
|
| Material |
Material to render the lines with (glow)
|
| MaterialNoGlow |
Material to render the lines with (no glow)
|
| MaxIndicesPerMesh |
Maximum indices per mesh
|
| MaxLinesPerMesh |
Maximum number of lines (quads) per mesh
|
| MaxVerticesPerMesh |
Maximum vertices per mesh
|
| QuadIndices |
Contains indices that allow rendering quads with a mesh, using QuadUV* uv coordinates. Array is MaxIndicesPerMesh in size, allowing
you to pull out that exact amount of indices you need into a new array. Unity really needs to provide index and count parameters
to really optimize the use of this array.
|
| QuadUV1 |
Quad UV1
|
| QuadUV2 |
Quad UV2
|
| QuadUV3 |
Quad UV3
|
| QuadUV4 |
Quad UV4
|
| ScreenRadiusMultiplier |
Experimental, screen radius multiplier, attempts to make lines stay the same radius on screen using this multiplier
|
| SortLayerName |
Sort layer
|
| SortOrderInLayer |
Sort order in layer
|
| StartCapScale |
Scale for start caps.
|
| TintColor |
Tint color. Applies globally to all lines and is applied in addition to individual line colors.
|
| Turbulence |
Turbulence. Requires lines to have LifeTime setup and works only at runtime. Applies globally in the Material rather than per vertex.
|
| UseWorldSpace |
True to use world space, false to use local space. Default is local space. World space will orient at 0,0,0 in world space. Local space will orient at 0,0,0 relative to parent.
|
| VerticesPerLine |
Number of vertices per line / quad
|
See Also