Shape class

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.

Inheritance: ShapeGeometryEntitySceneObjectA3DObject

The Shape type exposes the following members:

Constructors

ConstructorDescription
initInitializes a new instance of the Shape class.
initInitializes a new instance of the Shape class.

Properties

PropertyDescription
nameGets or sets the name.
propertiesGets the collection of all properties.
sceneGets the scene that this object belongs to
parent_nodesGets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
excludedGets or sets whether to exclude this entity during exporting.
parent_nodeGets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
visibleGets or sets if the geometry is visible
deformersGets all deformers associated with this geometry.
control_pointsGets all control points
cast_shadowsGets or sets whether this geometry can cast shadow
receive_shadowsGets or sets whether this geometry can receive shadow.
vertex_elementsGets all vertex elements
indicesGets the indices.

Methods

MethodDescription
remove_propertyRemoves a dynamic property.
remove_propertyRemove the specified property identified by name
create_elementCreates a vertex element with specified type and add it to the geometry.
create_elementCreates a vertex element with specified type and add it to the geometry.
create_element_uvCreates a VertexElementUV with given texture mapping type.
create_element_uvCreates a VertexElementUV with given texture mapping type.
get_propertyGet the value of specified property
set_propertySets the value of specified property
find_propertyFinds the property.
It can be a dynamic property (Created by CreateDynamicProperty/SetProperty)
or native property(Identified by its name)
get_bounding_boxGets the bounding box of current entity in its object space coordinate system.
get_entity_renderer_keyGets the key of the entity renderer registered in the renderer
get_elementGets a vertex element with specified type
get_vertex_element_of_uvGets a VertexElementUV instance with given texture mapping type
add_elementAdds an existing vertex element to current geometry
from_control_pointsCreate a shape with specified control points with a default indices.

See Also