SineSpace.Scripting.Components.SLineRenderer Class Reference

Inheritance diagram for SineSpace.Scripting.Components.SLineRenderer:

Public Member Functions
void	SetPosition (int index, SVector position)
	Set the position of a vertex in the line.
SVector	GetPosition (int index)
	Get the position of a vertex in the line.
void	SetPositions (SVector[] positions)
	Set the positions of all vertices in the line.
SVector[]	GetPositions ()
	Set the positions of all vertices in the line.
void	SetWidth (float start, float end)
	Set width at start and end.
void	SetColors (SColor start, SColor end)
	Set color at start and end (Line shader necessary)
Public Member Functions inherited from ScriptClassWrapper< T >
override void	Initialise (SScript runtime, object wrapper)
Public Member Functions inherited from ScriptClass
void	ReportError (string error, bool fatal, UnityEngine.Object target=null)
void	Initialise (SScript runtime, object wrapper)

Properties
bool	Enabled [get, set]
	Makes the rendered visible if enabled.
bool	ReceiveShadows [get, set]
	Enable this option to make the line display any shadows that are cast upon it.
bool	IsVisible [get]
	To check if this renderer is visible.
bool	CastShadows [get, set]
	Specify if and how the line casts shadows when a suitable Light shine on it.
bool	MotionVectors [get, set]
	Specifies whether this renderer has a per-object motion vector pass. If set to true, this object will have a per-object motion vector pass rendered.
bool	UseLightProbes [get, set]
	The light probe interpolation type.
float	StartWidth [get, set]
	Set the width at the start of the line.
float	EndWidth [get, set]
	Set the width at the end of the line.
float	WidthMultiplier [get, set]
	Set an overall multiplier that is applied to the LineRenderer.widthCurve to get the final width of the line.
SColor	StartColor [get, set]
	Set the color at the start of the line.
SColor	EndColor [get, set]
	Set the color at the end of the line.
int	PositionCount [get, set]
	Set/get the number of vertices.
bool	UseWorldSpace [get, set]
	If enabled, the points are considered as world space coordinates. If disabled, they are local to the transform of the GameObject to which this component is attached.
bool	Loop [get, set]
	Enable this to connect the first and last positions of the line, and form a closed loop.
int	NumCornerVertices [get, set]
	Set this to a value greater than 0, to get rounded corners between each segment of the line.
int	NumCapVertices [get, set]
	Set this to a value greater than 0, to get rounded corners on each end of the line.
int	TextureMode [get, set]
	Control how the Texture is applied to the line. (0-3)
int	Alignment [get, set]
	Set the direction that the line faces. (0 or 1)
Properties inherited from ScriptClassComponent< T >
SGameObject	GameObject [get]
	Return the GameObject which component added.
Properties inherited from ScriptClass< T >
override bool	Alive [get]
	Return if the component is alive.
Properties inherited from ScriptClassWrapper< T >
T	_wrap [get]
Properties inherited from ScriptClass
virtual bool	Alive [get]
DynValue	CachedData [get, set]

Additional Inherited Members
Protected Member Functions inherited from ScriptClass
void	Initialise (SScript runtime)

Member Function Documentation

GetPosition()

SVector SineSpace.Scripting.Components.SLineRenderer.GetPosition

(

int

index

)

Get the position of a vertex in the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
zeroPointPosition = lineRenderer.GetPosition(0)
–get the point at index 0 and set the point position after change position
Space.Log(zeroPointPosition.ToString())

GetPositions()

SVector[] SineSpace.Scripting.Components.SLineRenderer.GetPositions

(

)

Set the positions of all vertices in the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
positions = lineRenderer.GetPositions()
–get positions and output positions information.
for k,v in pairs(positions) do
     Space.Log(k..v.ToString())
end

SetColors()

void SineSpace.Scripting.Components.SLineRenderer.SetColors	(	SColor	start,
		SColor	end )

Set color at start and end (Line shader necessary)

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
lineRenderer.SetColors(Color.New(1,0,0,1),Color.New(0,1,0,1))
–set start color as pure red and end color as pure green.

SetPosition()

void SineSpace.Scripting.Components.SLineRenderer.SetPosition	(	int	index,
		SVector	position )

Set the position of a vertex in the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
zeroPointPosition = lineRenderer.GetPosition(0)
–get the point at 0 and set new point position after change position
zeroPointPosition.X =zeroPointPosition.X+1
lineRenderer.SetPosition(0,zeroPointPosition)

SetPositions()

void SineSpace.Scripting.Components.SLineRenderer.SetPositions

(

SVector[]

positions

)

Set the positions of all vertices in the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component
positions = lineRenderer.GetPositions()
–get the positions and modify, then set them to line renderer
for k,v in pairs(positions) do
       v.X = v.X+1
end
lineRenderer.SetPositions(positions)

SetWidth()

void SineSpace.Scripting.Components.SLineRenderer.SetWidth	(	float	start,
		float	end )

Set width at start and end.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
lineRenderer.SetWidth(0,3)
–set start width as 0 and end width as 3.

Property Documentation

Alignment

int SineSpace.Scripting.Components.SLineRenderer.Alignment

getset

Set the direction that the line faces. (0 or 1)

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component
lineRenderer.Alignment = 1
–set alignment to transform z

CastShadows

bool SineSpace.Scripting.Components.SLineRenderer.CastShadows

getset

Specify if and how the line casts shadows when a suitable Light shine on it.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
lineRenderer.CastShadows = false
–make this renderer unable to cast shadows.

Enabled

bool SineSpace.Scripting.Components.SLineRenderer.Enabled

getset

Makes the rendered visible if enabled.

lineRenderer = Space.Scene.Find("Line").LineRenderer
–get the LineRenderer component.
lineRenderer.Enabled = false
–disable line renderer to make line invisible

EndColor

SColor SineSpace.Scripting.Components.SLineRenderer.EndColor

getset

Set the color at the end of the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component
lineRenderer.EndColor = Color.New(0,1,0,1)
–set end color to pure green.

EndWidth

float SineSpace.Scripting.Components.SLineRenderer.EndWidth

getset

Set the width at the end of the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
lineRenderer.EndWidth = 3
–set end width to 3.

IsVisible

bool SineSpace.Scripting.Components.SLineRenderer.IsVisible

get

To check if this renderer is visible.

lineRenderer = Space.Scene.Find("Line").LineRenderer
–get the LineRenderer component on your line object
Space.Log(“”..lineRenderer.IsVisible) 
–output this renderer visible or not in your camera

Loop

bool SineSpace.Scripting.Components.SLineRenderer.Loop

getset

Enable this to connect the first and last positions of the line, and form a closed loop.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component on your line object
lineRenderer.Loop = true
–set loop as true.

MotionVectors

bool SineSpace.Scripting.Components.SLineRenderer.MotionVectors

getset

Specifies whether this renderer has a per-object motion vector pass. If set to true, this object will have a per-object motion vector pass rendered.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
lineRenderer.MotionVectors = true
–enable per object motion.

NumCapVertices

int SineSpace.Scripting.Components.SLineRenderer.NumCapVertices

getset

Set this to a value greater than 0, to get rounded corners on each end of the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component
lineRenderer.NumCapVertices = 27
–set cap vertices to 27 make end of the line smooth

NumCornerVertices

int SineSpace.Scripting.Components.SLineRenderer.NumCornerVertices

getset

Set this to a value greater than 0, to get rounded corners between each segment of the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component
lineRenderer. NumCornerVertices = 18
–set corner vertices to 18.

PositionCount

int SineSpace.Scripting.Components.SLineRenderer.PositionCount

getset

Set/get the number of vertices.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component
Space.Log(lineRenderer.PositionCount)
–show the number of vertices

ReceiveShadows

bool SineSpace.Scripting.Components.SLineRenderer.ReceiveShadows

getset

Enable this option to make the line display any shadows that are cast upon it.

lineRenderer = Space.Scene.Find("Line").LineRenderer
–get the LineRenderer component.
lineRenderer.ReceiveShadows = false
–make this renderer unable to receive shadows.

StartColor

SColor SineSpace.Scripting.Components.SLineRenderer.StartColor

getset

Set the color at the start of the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
lineRenderer.StartColor = Color.New(1,0,0,1)
–set start color to pure red.

StartWidth

float SineSpace.Scripting.Components.SLineRenderer.StartWidth

getset

Set the width at the start of the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
lineRenderer.StartWidth = 0
–set start width to 0.

TextureMode

int SineSpace.Scripting.Components.SLineRenderer.TextureMode

getset

Control how the Texture is applied to the line. (0-3)

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component
lineRenderer.TextureMode = 3
–set texture mode as repeat per segment

UseLightProbes

bool SineSpace.Scripting.Components.SLineRenderer.UseLightProbes

getset

The light probe interpolation type.

 lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
 lineRenderer.UseLightProbes = true
 –enable use light probes,

UseWorldSpace

bool SineSpace.Scripting.Components.SLineRenderer.UseWorldSpace

getset

If enabled, the points are considered as world space coordinates. If disabled, they are local to the transform of the GameObject to which this component is attached.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component
lineRenderer.UseWorldSpace = true
–set world use space as true

WidthMultiplier

float SineSpace.Scripting.Components.SLineRenderer.WidthMultiplier

getset

Set an overall multiplier that is applied to the LineRenderer.widthCurve to get the final width of the line.

lineRenderer = Space.Scene.Find(“Line”).LineRenderer
–get the LineRenderer component.
lineRenderer.WidthMultiplier = 3
–set widthmultiplier to 3.