Shape
Contents
[
Hide
]Shape class
The shape describes the deformation on a set of control points, which is similar to the cluster deformer in Maya. For example, we can add a shape to a created geometry. And the shape and the geometry have the same topological information but different position of the control points. With varying amounts of influence, the geometry performs a deformation effect.
Methods
constructor
| Name | Description |
|---|---|
| constructor() | Initializes a new instance of the Shape class. |
Result:
constructor_overload
| Name | Description |
|---|---|
| constructor_overload(name) | Initializes a new instance of the Shape class. |
Parameters:
| Name | Type | Description |
|---|---|---|
| name | String | Name |
Result:
getIndices
| Name | Description |
|---|---|
| getIndices() | Gets the indices. The indices. |
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:
getDeformers
| Name | Description |
|---|---|
| getDeformers() | Gets all deformers associated with this geometry. The deformers. |
Result:
getControlPoints
| Name | Description |
|---|---|
| getControlPoints() | Gets all control points |
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:
getVertexElements
| Name | Description |
|---|---|
| getVertexElements() | Gets all vertex elements |
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:
fromControlPoints
| Name | Description |
|---|---|
| fromControlPoints(controlPoints) | Create a shape with specified control points with a default indices. |
Parameters:
| Name | Type | Description |
|---|---|---|
| controlPoint | Vector3[] | null |
Result: Shape
getElement
| Name | Description |
|---|---|
| getElement(type) | Gets a vertex element with specified type |
Parameters:
| Name | Type | Description |
|---|---|---|
| type | VertexElementType | VertexElementType |
Result: VertexElement
getVertexElementOfUV
| Name | Description |
|---|---|
| getVertexElementOfUV(textureMapping) | Gets a VertexElementUV instance with given texture mapping type |
Parameters:
| Name | Type | Description |
|---|---|---|
| textureMapping | TextureMapping | TextureMapping |
Result: VertexElementUV
createElement
| Name | Description |
|---|---|
| createElement(type) | Creates a vertex element with specified type and add it to the geometry. If type is VertexElementType.UV, a VertexElementUV with texture mapping type to TextureMapping.DIFFUSE will be created. |
Parameters:
| Name | Type | Description |
|---|---|---|
| type | VertexElementType | VertexElementType |
Result: VertexElement
addElement
| Name | Description |
|---|---|
| addElement(element) | Adds an existing vertex element to current geometry |
Parameters:
| Name | Type | Description |
|---|---|---|
| element | VertexElement | The vertex element to add |
Result: VertexElement
createElement
| Name | Description |
|---|---|
| createElement(type, mappingMode, referenceMode) | Creates a vertex element with specified type and add it to the geometry. If type is VertexElementType.UV, a VertexElementUV with texture mapping type to TextureMapping.DIFFUSE will be created. |
Parameters:
| Name | Type | Description |
|---|---|---|
| type | VertexElementType | VertexElementType |
| mappingMode | MappingMode | MappingMode |
| referenceMode | ReferenceMode | ReferenceMode |
Result: VertexElement
createElementUV
| Name | Description |
|---|---|
| createElementUV(uvMapping) | Creates a VertexElementUV with given texture mapping type. |
Parameters:
| Name | Type | Description |
|---|---|---|
| uvMapping | TextureMapping | TextureMapping |
Result: VertexElementUV
createElementUV
| Name | Description |
|---|---|
| createElementUV(uvMapping, mappingMode, referenceMode) | Creates a VertexElementUV with given texture mapping type. |
Parameters:
| Name | Type | Description |
|---|---|---|
| uvMapping | TextureMapping | TextureMapping |
| mappingMode | MappingMode | MappingMode |
| referenceMode | ReferenceMode | ReferenceMode |
Result: VertexElementUV
getBoundingBox
| Name | Description |
|---|---|
| getBoundingBox() | Gets the bounding box of current entity in its object space coordinate system. |
Result: VertexElementUV
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