RectangularTorus
Contents
[
Hide
]RectangularTorus class
Parameterized rectangular torus.
Methods
constructor
Name | Description |
---|---|
constructor() | Constructor of RectangularTorus |
Result:
constructor_overload
Name | Description |
---|---|
constructor_overload(name) | Constructor of RectangularTorus |
Result:
getInnerRadius
Name | Description |
---|---|
getInnerRadius() | The inner radius of the rectangular torus Default value is 17 |
Result:
setInnerRadius
Name | Description |
---|---|
setInnerRadius(value) | The inner radius of the rectangular torus Default value is 17 |
Result:
getOuterRadius
Name | Description |
---|---|
getOuterRadius() | The outer radius of the rectangular torus Default value is 20 |
Result:
setOuterRadius
Name | Description |
---|---|
setOuterRadius(value) | The outer radius of the rectangular torus Default value is 20 |
Result:
getHeight
Name | Description |
---|---|
getHeight() | The height of the rectangular torus. Default value is 20 |
Result:
setHeight
Name | Description |
---|---|
setHeight(value) | The height of the rectangular torus. Default value is 20 |
Result:
getArc
Name | Description |
---|---|
getArc() | The total angle of the arc, measured in radian. Default value is PI |
Result:
setArc
Name | Description |
---|---|
setArc(value) | The total angle of the arc, measured in radian. Default value is PI |
Result:
getAngleStart
Name | Description |
---|---|
getAngleStart() | The start angle of the arc, measured in radian. Default value is 0 |
Result:
setAngleStart
Name | Description |
---|---|
setAngleStart(value) | The start angle of the arc, measured in radian. Default value is 0 |
Result:
getRadialSegments
Name | Description |
---|---|
getRadialSegments() | The radial segments, default value is 10 |
Result:
setRadialSegments
Name | Description |
---|---|
setRadialSegments(value) | The radial segments, default value is 10 |
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() |
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