Plane

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

public class Plane extends Primitive

Parameterized plane.

Constructors

Constructor	Description
Plane()	Initializes a new instance of the Plane with default size 1x1.
Plane(double length, double width)	Initializes a new instance of the Plane.
Plane(String name, double length, double width, int lengthSegments, int widthSegments)	Initializes a new instance of the Plane.

Methods

Method	Description
equals(Object arg0)
findProperty(String propertyName)	Finds the property.
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.
getLength()	Gets the length of the plane.
getLengthSegments()	Gets the length segments.
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
getUp()	Gets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane
getWidth()	Gets the width of the plane.
getWidthSegments()	Gets the width segments.
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.
setLength(double value)	Sets the length of the plane.
setLengthSegments(int value)	Sets the length segments.
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.
setUp(Vector3 value)	Sets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane
setWidth(double value)	Sets the width of the plane.
setWidthSegments(int value)	Sets the width segments.
toMesh()	Convert current object to mesh
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Plane()

public Plane()

Initializes a new instance of the Plane with default size 1x1.

Plane(double length, double width)

public Plane(double length, double width)

Initializes a new instance of the Plane.

Parameters:

Parameter	Type	Description
length	double	Length of the plane.
width	double	Width of the plane.

Plane(String name, double length, double width, int lengthSegments, int widthSegments)

public Plane(String name, double length, double width, int lengthSegments, int widthSegments)

Initializes a new instance of the Plane.

Parameters:

Parameter	Type	Description
name	java.lang.String	Name.
length	double	Length of the plane.
width	double	Width of the plane.
lengthSegments	int	Length segments.
widthSegments	int	Width segments.

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.

getBoundingBox()

public BoundingBox getBoundingBox()

Gets the bounding box of current entity in its object space coordinate system.

Returns: BoundingBox - 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());

getCastShadows()

public boolean getCastShadows()

Gets whether this geometry can cast shadow

Returns: boolean - whether this geometry can cast shadow

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 - the key of the entity renderer registered in the renderer

getExcluded()

public boolean getExcluded()

Gets whether to exclude this entity during exporting.

Returns: boolean - whether to exclude this entity during exporting.

getLength()

public double getLength()

Gets the length of the plane.

Returns: double - the length of the plane.

getLengthSegments()

public int getLengthSegments()

Gets the length segments.

Returns: int - the length segments.

getName()

public String getName()

Gets the name.

Returns: java.lang.String - the name.

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 - the first parent node, if set the first parent node, this entity will be detached from other parent nodes.

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> - all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing

getProperties()

public PropertyCollection getProperties()

Gets the collection of all properties.

Returns: PropertyCollection - the collection of all properties.

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 - whether this geometry can receive shadow.

getScene()

public Scene getScene()

Gets the scene that this object belongs to

Returns: Scene - the scene that this object belongs to

getUp()

public Vector3 getUp()

Gets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane

Returns: Vector3 - the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane

getWidth()

public double getWidth()

Gets the width of the plane.

Returns: double - the width of the plane.

getWidthSegments()

public int getWidthSegments()

Gets the width segments.

Returns: int - the width segments.

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	Which property to remove

Returns: boolean - true if the property is successfully removed

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

setLength(double value)

public void setLength(double value)

Sets the length of the plane.

Parameters:

Parameter	Type	Description
value	double	New value

setLengthSegments(int value)

public void setLengthSegments(int value)

Sets the length segments.

Parameters:

Parameter	Type	Description
value	int	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

setUp(Vector3 value)

public void setUp(Vector3 value)

Sets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane

Parameters:

Parameter	Type	Description
value	Vector3	New value

setWidth(double value)

public void setWidth(double value)

Sets the width of the plane.

Parameters:

Parameter	Type	Description
value	double	New value

setWidthSegments(int value)

public void setWidthSegments(int value)

Sets the width segments.

Parameters:

Parameter	Type	Description
value	int	New 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:

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