Line

Line class

A polyline is a path defined by a set of points with ControlPoints, and connected by Segments, which means it can also be a set of connected line segments. The line is usually a linear object, which means it cannot be used to represent a curve, in order to represent a curve, uses NurbsCurve.

public class Line : Curve

Constructors

Name Description
Line() Initializes a new instance of the Line class.
Line(string) Initializes a new instance of the Line class.

Properties

Name Description
Color { get; set; } Gets or sets the color of the line, default value is white(1, 1, 1)
ControlPoints { get; } Gets all control points
Excluded { get; set; } Gets or sets whether to exclude this entity during exporting.
virtual Name { get; set; } Gets or sets the name.
ParentNode { get; set; } Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
ParentNodes { get; } Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
Properties { get; } Gets the collection of all properties.
Scene { get; } Gets the scene that this object belongs to
Segments { get; } Gets the segments of the line
Visible { get; set; } Gets or sets if the geometry is visible

Methods

Name Description
static FromPoints(params Vector3[]) Construct a Line instance from a set of points.
FindProperty(string) Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name)
GetBoundingBox() Gets the bounding box of current entity in its object space coordinate system.
override GetEntityRendererKey() Gets the key of the entity renderer registered in the renderer
GetProperty(string) Get the value of specified property
MakeDefaultIndices() Generate the sequence 0,1,2,3….ControlPoints.Length-1 to Segments so the ControlPoints can be used as a single line
RemoveProperty(Property) Removes a dynamic property.
RemoveProperty(string) Remove the specified property identified by name
SetProperty(string, object) Sets the value of specified property

See Also