Tanoda
UnityEngine.UI.Extensions.UILineRenderer Class Reference
Inheritance diagram for UnityEngine.UI.Extensions.UILineRenderer:
UnityEngine.UI.Extensions.UIPrimitiveBase UnityEngine.UI.Extensions.UIGridRenderer

Public Types

enum  JoinType { Bevel , Miter }
 
enum  BezierType {
  None , Quick , Basic , Improved ,
  Catenary
}
 

Public Member Functions

Vector2 GetPosition (int index, int segmentIndex=0)
 Get the Vector2 position of a line index More...
 
Vector2 GetPositionBySegment (int index, int segment)
 Get the Vector2 position of a line within a specific segment More...
 
Vector2 GetClosestPoint (Vector2 p1, Vector2 p2, Vector2 p3)
 Get the closest point between two given Vector2s from a given Vector2 point More...
 
- Public Member Functions inherited from UnityEngine.UI.Extensions.UIPrimitiveBase
virtual void CalculateLayoutInputHorizontal ()
 
virtual void CalculateLayoutInputVertical ()
 
virtual bool IsRaycastLocationValid (Vector2 screenPoint, Camera eventCamera)
 

Public Attributes

JoinType LineJoins = JoinType.Bevel
 
BezierType BezierMode = BezierType.None
 
bool drivenExternally = false
 

Protected Member Functions

override void OnPopulateMesh (VertexHelper vh)
 
override void GeneratedUVs ()
 
override void ResolutionToNativeSize (float distance)
 
- Protected Member Functions inherited from UnityEngine.UI.Extensions.UIPrimitiveBase
 UIPrimitiveBase ()
 
UIVertex[] SetVbo (Vector2[] vertices, Vector2[] uvs)
 
Vector2[] IncreaseResolution (Vector2[] input)
 
List< Vector2 > IncreaseResolution (List< Vector2 > input)
 
virtual void GeneratedUVs ()
 
virtual void ResolutionToNativeSize (float distance)
 
override void OnEnable ()
 

Properties

float LineThickness [get, set]
 
bool RelativeSize [get, set]
 
bool LineList [get, set]
 
bool LineCaps [get, set]
 
int BezierSegmentsPerCurve [get, set]
 
Vector2[] Points [get, set]
 Points to be drawn in the line. More...
 
List< Vector2[]> Segments [get, set]
 List of Segments to be drawn. More...
 
- Properties inherited from UnityEngine.UI.Extensions.UIPrimitiveBase
Sprite sprite [get, set]
 
Sprite overrideSprite [get, set]
 
Sprite activeSprite [get]
 
float eventAlphaThreshold [get, set]
 
ResolutionMode ImproveResolution [get, set]
 
float Resolution [get, set]
 
bool UseNativeSize [get, set]
 
static Material defaultETC1GraphicMaterial [get]
 Default material used to draw everything if no explicit material was specified. More...
 
override Texture mainTexture [get]
 Image's texture comes from the UnityEngine.Image. More...
 
bool hasBorder [get]
 Whether the Image has a border to work with. More...
 
float pixelsPerUnit [get]
 
override Material material [get, set]
 
virtual float minWidth [get]
 
virtual float preferredWidth [get]
 
virtual float flexibleWidth [get]
 
virtual float minHeight [get]
 
virtual float preferredHeight [get]
 
virtual float flexibleHeight [get]
 
virtual int layoutPriority [get]
 

Additional Inherited Members

- Protected Attributes inherited from UnityEngine.UI.Extensions.UIPrimitiveBase
float m_Resolution
 
- Static Protected Attributes inherited from UnityEngine.UI.Extensions.UIPrimitiveBase
static Material s_ETC1DefaultUI = null
 

Detailed Description

Definition at line 11 of file UILineRenderer.cs.

Member Enumeration Documentation

◆ BezierType

Enumerator
None 
Quick 
Basic 
Improved 
Catenary 

Definition at line 27 of file UILineRenderer.cs.

◆ JoinType

Enumerator
Bevel 
Miter 

Definition at line 21 of file UILineRenderer.cs.

Member Function Documentation

◆ GeneratedUVs()

override void UnityEngine.UI.Extensions.UILineRenderer.GeneratedUVs ( )
protectedvirtual

Reimplemented from UnityEngine.UI.Extensions.UIPrimitiveBase.

Definition at line 339 of file UILineRenderer.cs.

◆ GetClosestPoint()

Vector2 UnityEngine.UI.Extensions.UILineRenderer.GetClosestPoint ( Vector2  p1,
Vector2  p2,
Vector2  p3 
)

Get the closest point between two given Vector2s from a given Vector2 point

Parameters
p1Starting position
p2End position
p3Desired / Selected point
Returns
Closest Vector2 position of the target within UI Space

Definition at line 453 of file UILineRenderer.cs.

◆ GetPosition()

Vector2 UnityEngine.UI.Extensions.UILineRenderer.GetPosition ( int  index,
int  segmentIndex = 0 
)

Get the Vector2 position of a line index

Positive numbers should be used to specify Index and Segment

Parameters
indexRequired Index of the point, starting from point 1
segmentIndex(optional) Required Segment the point is held in, Starting from Segment 1
Returns
Vector2 position of the point within UI Space

Definition at line 405 of file UILineRenderer.cs.

◆ GetPositionBySegment()

Vector2 UnityEngine.UI.Extensions.UILineRenderer.GetPositionBySegment ( int  index,
int  segment 
)

Get the Vector2 position of a line within a specific segment

Parameters
indexRequired Index of the point, starting from point 1
segmentIndexRequired Segment the point is held in, Starting from Segment 1
Returns
Vector2 position of the point within UI Space

Definition at line 441 of file UILineRenderer.cs.

◆ OnPopulateMesh()

override void UnityEngine.UI.Extensions.UILineRenderer.OnPopulateMesh ( VertexHelper  vh)
protected

Definition at line 270 of file UILineRenderer.cs.

◆ ResolutionToNativeSize()

override void UnityEngine.UI.Extensions.UILineRenderer.ResolutionToNativeSize ( float  distance)
protectedvirtual

Reimplemented from UnityEngine.UI.Extensions.UIPrimitiveBase.

Definition at line 373 of file UILineRenderer.cs.

Member Data Documentation

◆ BezierMode

BezierType UnityEngine.UI.Extensions.UILineRenderer.BezierMode = BezierType.None

Definition at line 90 of file UILineRenderer.cs.

◆ drivenExternally

bool UnityEngine.UI.Extensions.UILineRenderer.drivenExternally = false

Definition at line 99 of file UILineRenderer.cs.

◆ LineJoins

JoinType UnityEngine.UI.Extensions.UILineRenderer.LineJoins = JoinType.Bevel

Definition at line 87 of file UILineRenderer.cs.

Property Documentation

◆ BezierSegmentsPerCurve

int UnityEngine.UI.Extensions.UILineRenderer.BezierSegmentsPerCurve
getset

Definition at line 92 of file UILineRenderer.cs.

◆ LineCaps

bool UnityEngine.UI.Extensions.UILineRenderer.LineCaps
getset

Definition at line 80 of file UILineRenderer.cs.

◆ LineList

bool UnityEngine.UI.Extensions.UILineRenderer.LineList
getset

Definition at line 74 of file UILineRenderer.cs.

◆ LineThickness

float UnityEngine.UI.Extensions.UILineRenderer.LineThickness
getset

Definition at line 62 of file UILineRenderer.cs.

◆ Points

Vector2 [] UnityEngine.UI.Extensions.UILineRenderer.Points
getset

Points to be drawn in the line.

Definition at line 105 of file UILineRenderer.cs.

◆ RelativeSize

bool UnityEngine.UI.Extensions.UILineRenderer.RelativeSize
getset

Definition at line 68 of file UILineRenderer.cs.

◆ Segments

List<Vector2[]> UnityEngine.UI.Extensions.UILineRenderer.Segments
getset

List of Segments to be drawn.

Definition at line 124 of file UILineRenderer.cs.


The documentation for this class was generated from the following file: