Dish
Contents
[
Hide
]Dish class
Parameterized dish.
Methods
constructor
| Name | Description |
|---|---|
| constructor() | Create a new dish instance with default radius(10) and default height(5) |
Result:
constructor_overload
| Name | Description |
|---|---|
| constructor_overload(radius, height) | Create a new dish instance with specified radius and height |
Parameters:
| Name | Type | Description |
|---|---|---|
| radius | Number | The radius of the dish |
| height | Number | The height of the dish |
Result:
constructor_overload$2{#constructor_overload$2}
| Name | Description |
|---|---|
| constructor_overload$2(name, radius, height, widthSegments, heightSegments) | Create a new dish instance with specified radius and height |
Parameters:
| Name | Type | Description |
|---|---|---|
| name | String | The name of the dish |
| radius | Number | The radius of the dish |
| height | Number | The height of the dish |
| widthSegments | Number | The width segment of the dish |
| heightSegments | Number | The height segment of the dish |
Result:
getHeight
| Name | Description |
|---|---|
| getHeight() | Height of the dish |
Result:
setHeight
| Name | Description |
|---|---|
| setHeight(value) | Height of the dish |
Result:
getRadius
| Name | Description |
|---|---|
| getRadius() | Radius of the dish |
Result:
setRadius
| Name | Description |
|---|---|
| setRadius(value) | Radius of the dish |
Result:
getWidthSegments
| Name | Description |
|---|---|
| getWidthSegments() | Gets or sets the width segments |
Result:
setWidthSegments
| Name | Description |
|---|---|
| setWidthSegments(value) | Gets or sets the width segments |
Result:
getHeightSegments
| Name | Description |
|---|---|
| getHeightSegments() | Gets or sets the height segments |
Result:
setHeightSegments
| Name | Description |
|---|---|
| setHeightSegments(value) | Gets or sets the height 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