Shape

Inheritance: java.lang.Object, com.aspose.threed.A3DObject, com.aspose.threed.SceneObject, com.aspose.threed.Entity, com.aspose.threed.Geometry

public class Shape extends Geometry

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.

Constructors

Constructor	Description
Shape()	Initializes a new instance of the Shape class.
Shape(String name)	Initializes a new instance of the Shape class.

Methods

Method	Description
getDeformers2()	Gets all deformers with specified deformer types
addElement(VertexElement element)	Adds an existing vertex element to current geometry
createElement(VertexElementType type)	Creates a vertex element with specified type and add it to the geometry.
createElement(VertexElementType type, MappingMode mappingMode, ReferenceMode referenceMode)	Creates a vertex element with specified type and add it to the geometry.
createElementUV(TextureMapping uvMapping)	Creates a VertexElementUV with given texture mapping type.
createElementUV(TextureMapping uvMapping, MappingMode mappingMode, ReferenceMode referenceMode)	Creates a VertexElementUV with given texture mapping type.
equals(Object arg0)
findProperty(String propertyName)	Finds the property.
fromControlPoints(Vector3[] controlPoints)	Create a shape with specified control points with a default indices.
getBoundingBox()	Gets the bounding box of current entity in its object space coordinate system.
getCastShadows()	Gets whether this geometry can cast shadow
getClass()
getControlPoints()	Gets all control points
getDeformers()	Gets all deformers associated with this geometry.
getElement(VertexElementType type)	Gets a vertex element with specified type
getEntityRendererKey()	Gets the key of the entity renderer registered in the renderer
getExcluded()	Gets whether to exclude this entity during exporting.
getIndices()	Gets the indices.
getName()	Gets the name.
getParentNode()	Gets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
getParentNodes()	Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
getProperties()	Gets the collection of all properties.
getProperty(String property)	Get the value of specified property
getReceiveShadows()	Gets whether this geometry can receive shadow.
getScene()	Gets the scene that this object belongs to
getVertexElementOfUV(TextureMapping textureMapping)	Gets a VertexElementUV instance with given texture mapping type
getVertexElements()	Gets all vertex elements
getVisible()	Gets if the geometry is visible
hashCode()
notify()
notifyAll()
removeProperty(Property property)	Removes a dynamic property.
removeProperty(String property)	Remove the specified property identified by name
setCastShadows(boolean value)	Sets whether this geometry can cast shadow
setExcluded(boolean value)	Sets whether to exclude this entity during exporting.
setName(String value)	Sets the name.
setParentNode(Node value)	Sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
setProperty(String property, Object value)	Sets the value of specified property
setReceiveShadows(boolean value)	Sets whether this geometry can receive shadow.
setVisible(boolean value)	Sets if the geometry is visible
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Shape()

public Shape()

Initializes a new instance of the Shape class.

Shape(String name)

public Shape(String name)

Initializes a new instance of the Shape class.

Parameters:

Parameter	Type	Description
name	java.lang.String	Name

getDeformers2()

public Collection<T> <T>getDeformers2()

Gets all deformers with specified deformer types

Returns: java.util.Collection - Deformer collection

addElement(VertexElement element)

public void addElement(VertexElement element)

Adds an existing vertex element to current geometry

Parameters:

Parameter	Type	Description
element	VertexElement	The vertex element to add

createElement(VertexElementType type)

public VertexElement createElement(VertexElementType type)

Creates a vertex element with specified type and add it to the geometry.

Parameters:

Parameter	Type	Description
type	VertexElementType	Vertex element type

Returns: VertexElement - Created element. Remarks: If type is VertexElementType.UV, a VertexElementUV with texture mapping type to TextureMapping.DIFFUSE will be created.

createElement(VertexElementType type, MappingMode mappingMode, ReferenceMode referenceMode)

public VertexElement createElement(VertexElementType type, MappingMode mappingMode, ReferenceMode referenceMode)

Creates a vertex element with specified type and add it to the geometry.

Parameters:

Parameter	Type	Description
type	VertexElementType	Vertex element type
mappingMode	MappingMode	Default mapping mode
referenceMode	ReferenceMode	Default reference mode

Returns: VertexElement - Created element. Remarks: If type is VertexElementType.UV, a VertexElementUV with texture mapping type to TextureMapping.DIFFUSE will be created.

createElementUV(TextureMapping uvMapping)

public VertexElementUV createElementUV(TextureMapping uvMapping)

Creates a VertexElementUV with given texture mapping type.

Parameters:

Parameter	Type	Description
uvMapping	TextureMapping	Which texture mapping type to create

Returns: VertexElementUV - Created element uv

createElementUV(TextureMapping uvMapping, MappingMode mappingMode, ReferenceMode referenceMode)

public VertexElementUV createElementUV(TextureMapping uvMapping, MappingMode mappingMode, ReferenceMode referenceMode)

Creates a VertexElementUV with given texture mapping type.

Parameters:

Parameter	Type	Description
uvMapping	TextureMapping	Which texture mapping type to create
mappingMode	MappingMode	Default mapping mode
referenceMode	ReferenceMode	Default reference mode

Returns: VertexElementUV - Created element uv

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

findProperty(String propertyName)

public Property findProperty(String propertyName)

Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name)

Parameters:

Parameter	Type	Description
propertyName	java.lang.String	Property name.

Returns: Property - The property.

fromControlPoints(Vector3[] controlPoints)

public static Shape fromControlPoints(Vector3[] controlPoints)

Create a shape with specified control points with a default indices.

Parameters:

Parameter	Type	Description
controlPoints	Vector3[]

Returns: Shape

getBoundingBox()

public BoundingBox getBoundingBox()

Gets the bounding box of current entity in its object space coordinate system. Example: The following code shows how to calculate the bounding box of a shape

Entity entity = new Sphere();
     entity.setRadius(10);
     var bbox = entity.getBoundingBox();
     System.out.printf("The bounding box of the entity is %s ~ %s", bbox.getMinimum(), bbox.getMaximum());

Returns: BoundingBox

getCastShadows()

public boolean getCastShadows()

Gets whether this geometry can cast shadow

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getControlPoints()

public List<Vector4> getControlPoints()

Gets all control points

Returns: java.util.List<com.aspose.threed.Vector4>

getDeformers()

public List<Deformer> getDeformers()

Gets all deformers associated with this geometry.

Returns: java.util.List<com.aspose.threed.Deformer>

getElement(VertexElementType type)

public VertexElement getElement(VertexElementType type)

Gets a vertex element with specified type

Parameters:

Parameter	Type	Description
type	VertexElementType	which vertex element type to find

Returns: VertexElement - VertexElement instance if found, otherwise null will be returned.

getEntityRendererKey()

public EntityRendererKey getEntityRendererKey()

Gets the key of the entity renderer registered in the renderer

Returns: EntityRendererKey

getExcluded()

public boolean getExcluded()

Gets whether to exclude this entity during exporting.

Returns: boolean

getIndices()

public List<Integer> getIndices()

Gets the indices.

Returns: java.util.List<java.lang.Integer>

getName()

public String getName()

Gets the name.

Returns: java.lang.String

getParentNode()

public Node getParentNode()

Gets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.

Returns: Node

getParentNodes()

public ArrayList<Node> getParentNodes()

Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing

Returns: java.util.ArrayList<com.aspose.threed.Node>

getProperties()

public PropertyCollection getProperties()

Gets the collection of all properties.

Returns: PropertyCollection

getProperty(String property)

public Object getProperty(String property)

Get the value of specified property

Parameters:

Parameter	Type	Description
property	java.lang.String	Property name

Returns: java.lang.Object - The value of the found property

getReceiveShadows()

public boolean getReceiveShadows()

Gets whether this geometry can receive shadow.

Returns: boolean

getScene()

public Scene getScene()

Gets the scene that this object belongs to

Returns: Scene

getVertexElementOfUV(TextureMapping textureMapping)

public VertexElementUV getVertexElementOfUV(TextureMapping textureMapping)

Gets a VertexElementUV instance with given texture mapping type

Parameters:

Parameter	Type	Description
textureMapping	TextureMapping

Returns: VertexElementUV - VertexElementUV with the texture mapping type

getVertexElements()

public List<VertexElement> getVertexElements()

Gets all vertex elements

Returns: java.util.List<com.aspose.threed.VertexElement>

getVisible()

public boolean getVisible()

Gets if the geometry is visible

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeProperty(Property property)

public boolean removeProperty(Property property)

Removes a dynamic property.

Parameters:

Parameter	Type	Description
property	Property	Which property to remove

Returns: boolean - true if the property is successfully removed

removeProperty(String property)

public boolean removeProperty(String property)

Remove the specified property identified by name

Parameters:

Parameter	Type	Description
property	java.lang.String

Returns: boolean

setCastShadows(boolean value)

public void setCastShadows(boolean value)

Sets whether this geometry can cast shadow

Parameters:

Parameter	Type	Description
value	boolean	New value

setExcluded(boolean value)

public void setExcluded(boolean value)

Sets whether to exclude this entity during exporting.

Parameters:

Parameter	Type	Description
value	boolean	New value

setName(String value)

public void setName(String value)

Sets the name.

Parameters:

Parameter	Type	Description
value	java.lang.String	New value

setParentNode(Node value)

public void setParentNode(Node value)

Sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.

Parameters:

Parameter	Type	Description
value	Node	New value

setProperty(String property, Object value)

public void setProperty(String property, Object value)

Sets the value of specified property

Parameters:

Parameter	Type	Description
property	java.lang.String	Property name
value	java.lang.Object	The value of the property

setReceiveShadows(boolean value)

public void setReceiveShadows(boolean value)

Sets whether this geometry can receive shadow.

Parameters:

Parameter	Type	Description
value	boolean	New value

setVisible(boolean value)

public void setVisible(boolean value)

Sets if the geometry is visible

Parameters:

Parameter	Type	Description
value	boolean	New value

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int