Link Search Menu Expand Document

Thickline

Draw a line that can have a custom width.

All wire objects have a set of basic attributes {object_id, action, type, persist, data}. The data attribute defines the object-specific attributes

Thickline Attributes

Attribute Type Default Description Required
object_id string   A uuid or otherwise unique identifier for this object. Yes
persist boolean True Persist this object in the database. Yes
type string; Must be: object 'object' AFrame 3D Object Yes
action string; One of: ['create', 'delete', 'update'] 'create' Message action create, update, delete. Yes
ttl number   When applied to an entity, the entity will remove itself from DOM after the specified number of seconds. Update is allowed, which will reset the timer to start from that moment. No
private boolean False If true, interactions with this object should not be broadcasted to other clients, but rather sent on private topics No
program_id string   The program_id on private program topics that interactions to be directed to, if the private flag is set true. Ignored if private flag is false. No
data Thickline data   Thickline Data Yes

Thickline Data Attributes

Attribute Type Default Description Required
object_type string; Must be: thickline thickline 3D object type. Yes
color string '#000000' Line color. Yes
lineWidth number 1 Width of line in px. Yes
lineWidthStyler string; One of: ['default', 'grow', 'shrink', 'center-sharp', 'center-smooth', 'sine-wave'] 'default' Allows defining the line width as a function of relative position p along the path of the line. By default it is set to a constant 1. You may also choose one of the preset functions. Yes
path string '-2 -1 0, 0 20 0, 10 -1 10' Comma-separated list of x y z coordinates of the line vertices. Yes
parent string   Parent’s object_id. Child objects inherit attributes of their parent, for example scale and translation. No
position position   3D object position. No
rotation rotation   3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format. No
scale scale   3D object scale. No
visible boolean True Whether object is visible. Property is inherited. No