com.aspose.threed

Class Plane

java.lang.Object

com.aspose.threed.A3DObject

com.aspose.threed.SceneObject

com.aspose.threed.Entity

com.aspose.threed.Primitive

com.aspose.threed.Plane

All Implemented Interfaces:

IMeshConvertible

public class Plane
extends Primitive

Parameterized plane.

Field Summary

Fields inherited from class com.aspose.threed.A3DObject

name, properties

Constructor Summary

Constructors

Constructor and 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(java.lang.String name, double length, double width, int lengthSegments, int widthSegments) Initializes a new instance of the Plane.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Check if two planes equal
double	getLength() Gets the length of the plane.
int	getLengthSegments() Gets the length segments.
Vector3	getUp() Gets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane
double	getWidth() Gets the width of the plane.
int	getWidthSegments() Gets the width segments.
int	hashCode() Gets the hash code of current primitive instance
void	setLength(double value) Sets the length of the plane.
void	setLengthSegments(int value) Sets the length segments.
void	setUp(Vector3 value) Sets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane
void	setWidth(double value) Sets the width of the plane.
void	setWidthSegments(int value) Sets the width segments.
Mesh	toMesh() Convert current object to mesh

Methods inherited from class com.aspose.threed.Primitive

createEmptyMesh, getCastShadows, getReceiveShadows, merge, setCastShadows, setReceiveShadows, setup

Methods inherited from class com.aspose.threed.Entity

getBoundingBox, getEntityRendererKey, getExcluded, getParentNode, getParentNodes, setExcluded, setParentNode

Methods inherited from class com.aspose.threed.SceneObject

getScene

Methods inherited from class com.aspose.threed.A3DObject

findProperty, getName, getProperties, getProperty, removeProperty, removeProperty, setName, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Plane

public Plane()

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

Plane

public Plane(double length,
             double width)

Initializes a new instance of the Plane.

Parameters:

length - Length of the plane.

width - Width of the plane.

Plane

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

Initializes a new instance of the Plane.

Parameters:

name - Name.

length - Length of the plane.

width - Width of the plane.

lengthSegments - Length segments.

widthSegments - Width segments.

Method Detail

getUp

public Vector3 getUp()

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

setUp

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:

value - New value

equals

public boolean equals(java.lang.Object obj)

Check if two planes equal

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to check equality.

Returns:

True if all properties are identically equal.

getLength

public double getLength()

Gets the length of the plane.

setLength

public void setLength(double value)

Sets the length of the plane.

Parameters:

value - New value

getWidth

public double getWidth()

Gets the width of the plane.

setWidth

public void setWidth(double value)

Sets the width of the plane.

Parameters:

value - New value

getLengthSegments

public int getLengthSegments()

Gets the length segments.

setLengthSegments

public void setLengthSegments(int value)

Sets the length segments.

Parameters:

value - New value

getWidthSegments

public int getWidthSegments()

Gets the width segments.

setWidthSegments

public void setWidthSegments(int value)

Sets the width segments.

Parameters:

value - New value

toMesh

public Mesh toMesh()

Convert current object to mesh

Specified by:

toMesh in interface IMeshConvertible

Specified by:

toMesh in class Primitive

Returns:

The mesh.

hashCode

public int hashCode()

Gets the hash code of current primitive instance

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code of the Plane