Pyramid

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

public class Pyramid extends Primitive

Parameterized pyramid.

Constructors

ConstructorDescription
Pyramid()Construct a new pyramid instance with default bottom area(10, 10) and default height(5)
Pyramid(double xbottom, double ybottom, double height)Construct a new pyramid instance with specified bottom area
Pyramid(double xbottom, double ybottom, double xtop, double ytop, double height)Construct a new pyramid instance with specified bottom area and top area and height.
Pyramid(String name, double xbottom, double ybottom, double xtop, double ytop, double height)Construct a new pyramid instance with specified bottom area and top area and height.

Methods

MethodDescription
equals(Object arg0)
findProperty(String propertyName)Finds the property.
getBottomArea()Area of the bottom cap
getBottomOffset()Offset for bottom vertices
getBoundingBox()Gets the bounding box of current entity in its object space coordinate system.
getCastShadows()Gets whether this geometry can cast shadow
getClass()
getEntityRendererKey()Gets the key of the entity renderer registered in the renderer
getExcluded()Gets whether to exclude this entity during exporting.
getHeight()Height of the pyramid
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
getTopArea()Area of the top cap
hashCode()
notify()
notifyAll()
removeProperty(Property property)Removes a dynamic property.
removeProperty(String property)Remove the specified property identified by name
setBottomArea(Vector2 value)Area of the bottom cap
setBottomOffset(Vector3 value)Offset for bottom vertices
setCastShadows(boolean value)Sets whether this geometry can cast shadow
setExcluded(boolean value)Sets whether to exclude this entity during exporting.
setHeight(double value)Height of the pyramid
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.
setTopArea(Vector2 value)Area of the top cap
toMesh()Convert current object to mesh
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Pyramid()

public Pyramid()

Construct a new pyramid instance with default bottom area(10, 10) and default height(5)

Pyramid(double xbottom, double ybottom, double height)

public Pyramid(double xbottom, double ybottom, double height)

Construct a new pyramid instance with specified bottom area

Parameters:

ParameterTypeDescription
xbottomdoubleThe x-direction length of the bottom
ybottomdoubleThe y-direction length of the bottom
heightdoubleThe height of the pyramid

Pyramid(double xbottom, double ybottom, double xtop, double ytop, double height)

public Pyramid(double xbottom, double ybottom, double xtop, double ytop, double height)

Construct a new pyramid instance with specified bottom area and top area and height.

Parameters:

ParameterTypeDescription
xbottomdoubleThe x-direction length of the bottom area
ybottomdoubleThe y-direction length of the bottom area
xtopdoubleThe x-direction length of the top area
ytopdoubleThe y-direction length of the top area
heightdoubleThe height of the pyramid

Pyramid(String name, double xbottom, double ybottom, double xtop, double ytop, double height)

public Pyramid(String name, double xbottom, double ybottom, double xtop, double ytop, double height)

Construct a new pyramid instance with specified bottom area and top area and height.

Parameters:

ParameterTypeDescription
namejava.lang.StringThe name of the pyramid
xbottomdoubleThe x-direction length of the bottom area
ybottomdoubleThe y-direction length of the bottom area
xtopdoubleThe x-direction length of the top area
ytopdoubleThe y-direction length of the top area
heightdoubleThe height of the pyramid

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.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:

ParameterTypeDescription
propertyNamejava.lang.StringProperty name.

Returns: Property - The property.

getBottomArea()

public Vector2 getBottomArea()

Area of the bottom cap

Returns: Vector2

getBottomOffset()

public Vector3 getBottomOffset()

Offset for bottom vertices

Returns: Vector3

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

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

getHeight()

public double getHeight()

Height of the pyramid

Returns: double

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:

ParameterTypeDescription
propertyjava.lang.StringProperty 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

getTopArea()

public Vector2 getTopArea()

Area of the top cap

Returns: Vector2

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:

ParameterTypeDescription
propertyPropertyWhich 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:

ParameterTypeDescription
propertyjava.lang.String

Returns: boolean

setBottomArea(Vector2 value)

public void setBottomArea(Vector2 value)

Area of the bottom cap

Parameters:

ParameterTypeDescription
valueVector2New value

setBottomOffset(Vector3 value)

public void setBottomOffset(Vector3 value)

Offset for bottom vertices

Parameters:

ParameterTypeDescription
valueVector3New value

setCastShadows(boolean value)

public void setCastShadows(boolean value)

Sets whether this geometry can cast shadow

Parameters:

ParameterTypeDescription
valuebooleanNew value

setExcluded(boolean value)

public void setExcluded(boolean value)

Sets whether to exclude this entity during exporting.

Parameters:

ParameterTypeDescription
valuebooleanNew value

setHeight(double value)

public void setHeight(double value)

Height of the pyramid

Parameters:

ParameterTypeDescription
valuedoubleNew value

setName(String value)

public void setName(String value)

Sets the name.

Parameters:

ParameterTypeDescription
valuejava.lang.StringNew 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:

ParameterTypeDescription
valueNodeNew value

setProperty(String property, Object value)

public void setProperty(String property, Object value)

Sets the value of specified property

Parameters:

ParameterTypeDescription
propertyjava.lang.StringProperty name
valuejava.lang.ObjectThe value of the property

setReceiveShadows(boolean value)

public void setReceiveShadows(boolean value)

Sets whether this geometry can receive shadow.

Parameters:

ParameterTypeDescription
valuebooleanNew value

setTopArea(Vector2 value)

public void setTopArea(Vector2 value)

Area of the top cap

Parameters:

ParameterTypeDescription
valueVector2New value

toMesh()

public Mesh toMesh()

Convert current object to mesh

Returns: Mesh - The mesh.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int