Plane
Contents
[
Hide
]Plane class
Parameterized plane.
Methods
constructor
| Name | Description |
|---|---|
| constructor() | Initializes a new instance of the Plane with default size 1x1. |
Result:
constructor_overload
| Name | Description |
|---|---|
| constructor_overload(length, width) | Initializes a new instance of the Plane. |
Parameters:
| Name | Type | Description |
|---|---|---|
| length | Number | Length of the plane. |
| width | Number | Width of the plane. |
Result:
constructor_overload$2{#constructor_overload$2}
| Name | Description |
|---|---|
| constructor_overload$2(name, length, width, lengthSegments, widthSegments) | Initializes a new instance of the Plane. |
Parameters:
| Name | Type | Description |
|---|---|---|
| name | String | Name. |
| length | Number | Length of the plane. |
| width | Number | Width of the plane. |
| lengthSegments | Number | Length segments. |
| widthSegments | Number | Width segments. |
Result:
getUp
| Name | Description |
|---|---|
| getUp() | Gets or sets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane |
Result:
setUp
| Name | Description |
|---|---|
| setUp(value) | Gets or sets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane |
Result:
getLength
| Name | Description |
|---|---|
| getLength() | Gets or sets the length of the plane. The length. |
Result:
setLength
| Name | Description |
|---|---|
| setLength(value) | Gets or sets the length of the plane. The length. |
Result:
getWidth
| Name | Description |
|---|---|
| getWidth() | Gets or sets the width of the plane. The width. |
Result:
setWidth
| Name | Description |
|---|---|
| setWidth(value) | Gets or sets the width of the plane. The width. |
Result:
getLengthSegments
| Name | Description |
|---|---|
| getLengthSegments() | Gets or sets the length segments. The length segments. |
Result:
setLengthSegments
| Name | Description |
|---|---|
| setLengthSegments(value) | Gets or sets the length segments. The length segments. |
Result:
getWidthSegments
| Name | Description |
|---|---|
| getWidthSegments() | Gets or sets the width segments. The width segments. |
Result:
setWidthSegments
| Name | Description |
|---|---|
| setWidthSegments(value) | Gets or sets the width segments. The width segments. |
Result:
getCastShadows
| Name | Description |
|---|---|
| getCastShadows() | Gets or sets whether this geometry can cast shadow |
Result:
setCastShadows
| Name | Description |
|---|---|
| setCastShadows(value) | Gets or sets whether this geometry can cast shadow |
Result:
getReceiveShadows
| Name | Description |
|---|---|
| getReceiveShadows() | Gets or sets whether this geometry can receive shadow. |
Result:
setReceiveShadows
| Name | Description |
|---|---|
| setReceiveShadows(value) | Gets or sets whether this geometry can receive shadow. |
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:
toMesh
| Name | Description |
|---|---|
| toMesh() | Convert current object to mesh |
Result: Mesh
getBoundingBox
| Name | Description |
|---|---|
| getBoundingBox() | Gets the bounding box of current entity in its object space coordinate system. |
Result: Mesh
getEntityRendererKey
| Name | Description |
|---|---|
| getEntityRendererKey() | Gets the key of the entity renderer registered in the renderer |
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