Line
Contents
[
Hide
]Line class
A polyline is a path defined by a set of points with Geometry.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.
Methods
constructor
| Name | Description |
|---|---|
| constructor() | Initializes a new instance of the Line class. |
Result:
constructor_overload
| Name | Description |
|---|---|
| constructor_overload(name) | Initializes a new instance of the Line class. |
Parameters:
| Name | Type | Description |
|---|---|---|
| name | String | Name. |
Result:
getControlPoints
| Name | Description |
|---|---|
| getControlPoints() | Gets all control points |
Result:
getVisible
| Name | Description |
|---|---|
| getVisible() | Gets or sets if the geometry is visible |
Result:
setVisible
| Name | Description |
|---|---|
| setVisible(value) | Gets or sets if the geometry is visible |
Result:
getSegments
| Name | Description |
|---|---|
| getSegments() | Gets the segments of the line |
Result:
getColor
| Name | Description |
|---|---|
| getColor() | Gets or sets the color of the line, default value is white(1, 1, 1) |
Result:
setColor
| Name | Description |
|---|---|
| setColor(value) | Gets or sets the color of the line, default value is white(1, 1, 1) |
Result:
getParentNodes
| Name | Description |
|---|---|
| getParentNodes() | Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing The nodes. |
Result:
getExcluded
| Name | Description |
|---|---|
| getExcluded() | Gets or sets whether to exclude this entity during exporting. |
Result:
setExcluded
| Name | Description |
|---|---|
| setExcluded(value) | Gets or sets whether to exclude this entity during exporting. |
Result:
getParentNode
| Name | Description |
|---|---|
| getParentNode() | Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node. |
Result:
setParentNode
| Name | Description |
|---|---|
| setParentNode(value) | Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node. |
Result:
getScene
| Name | Description |
|---|---|
| getScene() | Gets the scene that this object belongs to |
Result:
getName
| Name | Description |
|---|---|
| getName() | Gets or sets the name. The name. |
Result:
setName
| Name | Description |
|---|---|
| setName(value) | Gets or sets the name. The name. |
Result:
getProperties
| Name | Description |
|---|---|
| getProperties() | Gets the collection of all properties. |
Result:
fromPoints
| Name | Description |
|---|---|
| fromPoints(points) | Construct a Line instance from a set of points. |
Parameters:
| Name | Type | Description |
|---|---|---|
| point | Vector3[] | null |
Result: Line
makeDefaultIndices
| Name | Description |
|---|---|
| makeDefaultIndices() | Generate the sequence 0,1,2,3….Geometry.ControlPoints.Length-1 to Segments so the ControlPoints can be used as a single line |
Result: Line
getEntityRendererKey
| Name | Description |
|---|---|
| getEntityRendererKey() | Gets the key of the entity renderer registered in the renderer |
Result: EntityRendererKey
getBoundingBox
| Name | Description |
|---|---|
| getBoundingBox() | Gets the bounding box of current entity in its object space coordinate system. |
Result: EntityRendererKey
removeProperty
| Name | Description |
|---|---|
| removeProperty(property) | Removes a dynamic property. |
Parameters:
| Name | Type | Description |
|---|---|---|
| property | Property | Which property to remove |
Result: boolean
removeProperty
| Name | Description |
|---|---|
| removeProperty(property) | Remove the specified property identified by name |
Parameters:
| Name | Type | Description |
|---|---|---|
| propert | String | null |
Result: boolean
getProperty
| Name | Description |
|---|---|
| getProperty(property) | Get the value of specified property |
Parameters:
| Name | Type | Description |
|---|---|---|
| property | String | Property name |
Result: Object
setProperty
| Name | Description |
|---|---|
| setProperty(property, value) | Sets the value of specified property |
Parameters:
| Name | Type | Description |
|---|---|---|
| property | String | Property name |
| value | Object | The value of the property |
Result: Object
findProperty
| Name | Description |
|---|---|
| findProperty(propertyName) | Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name) |
Parameters:
| Name | Type | Description |
|---|---|---|
| propertyName | String | Property name. |
Result: Property