Vectrosity5 Reference Guide

VectorLine constructor and properties

........................VectorLine (constructor)! 2

.....................................................active! 3

.........................alignOddWidthToPixels! 3

.............................................capLength! 3

..................................................collider! 3

......................................................color! 3

.................................continuousTexture! 4

............................................drawDepth! 4

......................................................joins! 5

......................................................layer! 5

...............................................lineWidth! 6

..................................................material! 6

....................................................matrix! 6

.................................maxWeldDistance! 6

.....................................................name! 6

.....................................physicsMaterial! 6

..................................................points2! 7

..........................................textureScale! 8

....................................................trigger! 8

..............................useViewportCoords! 8

VectorLine functions

..........................................AddNormals! 9

.........................................AddTangents! 9

......................................................Draw! 9

..................................................Draw3D! 9

........................................Draw3DAuto! 10

.............................................GetWidth! 12

..............................................MakeArc! 13

.......................................SetDistances! 23

.................................SetEndCapColor! 23

..............................................SetMask! 23

..............................................SetWidth! 24

...........................................SetWidths! 24

...........................StopDrawing3DAuto! 24

VectorLine static functions and properties

.................................................canvas! 25

.................................................SetRay! 30

................................................Version! 30

VectorManager functions and properties

joins : Joins = Joins.None) : VectorLine

name is a string that’s used to name the GameObject and mesh created for the vector line. The name is also

used to identify bounds meshes made with VectorManager.ObjectSetup.

points is a Vector2 or Vector3 generic List, where each entry is a point in the line using screen-space

coordinates (in the case of a Vector2 list), or world units (in the case of a Vector3 list). The list may be empty

initially, with points added later. If the list is declared with an initial capacity (i.e., “new List<Vector2>(50)”), the

list will have the capacity filled with Vector2.zero or Vector3.zero as appropriate, so the list.Count will equal

the list.Capacity.

The line is drawn using the supplied texture. If the texture is omitted, the line is drawn as a solid color.

The lineWidth is the width in pixels. This is a float, so values like 1.5 are acceptable.

angle, primarily used with thick lines with no texture. This only works if using LineType.Continuous.

appropriate for textured lines. Joins.Weld works with LineType.Discrete, but only for sequential line

segments. When using LineType.Points, only Joins.None can be used.

A note about function parameters

All parameters where only the type is listed must be supplied. All parameters where a default value is listed

are optional, and will use the default value if they are omitted.

" 2

active

var active : boolean = true;

Sets a VectorLine active or inactive. Inactive VectorLines won’t be rendered, and if an inactive VectorLine is

used with functions like Draw, the function will return immediately without doing anything.

alignOddWidthToPixels

var alignOddWidthToPixels = false;

Sets the line’s capLength to the supplied float. This is the number of pixels added to either end of the line (0

by default). Typically used for filling in gaps seen in thick lines when they are joined at right angles, such as

when drawing selection boxes or other rectangles.

collider

var collider : boolean = false;

If true, the line will generate a matching 2D collider when it’s drawn. The collider is updated if the line is

changed and re-drawn. Setting this to false will disable the collider, if one existed previously. The collider

works with lines made with Vector3 points as well as lines made with Vector2 points. Since 2D colliders are

on the X/Y plane only, the camera should be facing along the Z axis, with no rotation, in order for the collider

to correctly match the line.

color

var color : Color = Color.white;

VectorLine.SetColor and VectorLine.SetColors. Note that VectorLine.color will retain its original value even if

" 3

continuousTexture

var continuousTexture : boolean = false;

If this is set to true, then any texture used for the line will be stretched evenly along the entire length of the

The sibling index of the VectorLine as drawn in the vector canvas. Lines with higher drawDepth values are

drawn on top of lines with lower drawDepth values. Each line has a unique drawDepth value, which is

assigned in order as more VectorLines are created, so changing the drawDepth value for one line may

change the values of others. The minimum is 0, and the maximum depends on the number of VectorLines

parented to an object (which is the vector canvas by default, but can be changed using

VectorLine.rectTransform). VectorLine.drawDepth can’t be used on lines drawn with Draw3D.

drawEnd

var drawEnd : int;

Specifies the index in the VectorLine’s points list at which line drawing should end. Any later points will be

erased when VectorLine.Draw is called. (Erased on-screen, not from the points list.) When used with a

discrete line, drawEnd should be an odd number, although it can be 0. If it’s even (aside from 0), it will be

incremented to the next highest integer. It’s clamped between 0 and points.Count-1. This can be used with

integer. It’s clamped between 0 and points2.Length-1 or points3.Length-1.

drawTransform

var drawTransform : Transform;

When drawn, the line is modified by the supplied transform. For example, if the transform is located at

Vector3(5.0, 2.0, 0.0), then the line is offset by 5 units on the X axis and 2 units on the Y axis. A transform

the line to be scaled by the same amount, though it will always be drawn with the correct thickness. If the

transform is modified, the line will need to be re-drawn in order to reflect the changes.

" 4

endCap

var endCap : String;

Specifies an end cap for the VectorLine, using a name as defined in SetEndCap. The name is case-sensitive,

and SetEndCap must have been called before an end cap can be added. If null or "" is used for the string,

then the end cap is removed from the VectorLine.

endPointsUpdate

var endPointsUpdate : int = 0;

joins

The GameObject layer of the line, for use with culling masks. By default this is the UI layer.

" 5