Cylinder

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

public class Cylinder extends Primitive

Parameterized Cylinder. It can also be used to represent the cone when one of radiusTop/radiusBottom is zero.

Constructors

ConstructorDescription
Cylinder()Initializes a new instance of the Cylinder class.
Cylinder(double radius, double height)Initializes a new instance of the Cylinder class.
Cylinder(double radiusTop, double radiusBottom, double height)Initializes a new instance of the Cylinder class.
Cylinder(double radiusTop, double radiusBottom, double height, int radialSegments, int heightSegments, boolean openEnded)Initializes a new instance of the Cylinder class.
Cylinder(String name, double radiusTop, double radiusBottom, double height, int radialSegments, int heightSegments, boolean openEnded, double thetaStart, double thetaLength)Initializes a new instance of the Cylinder class.

Methods

MethodDescription
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.
getGenerateFanCylinder()Gets whether to generate the fan-style cylinder when the ThetaLength is less than 2*PI, otherwise the model will not be cut.
getHeight()Gets the height of the cylinder.
getHeightSegments()Gets the height segments.
getName()Gets the name.
getOffsetBottom()Gets the vertices transformation offset of the bottom side.
getOffsetTop()Gets the vertices transformation offset of the top side.
getOpenEnded()Gets a value indicating whether this Cylinder open ended.
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
getRadialSegments()Gets the radial segments.
getRadiusBottom()Gets the radius of cylinder’s bottom cap.
getRadiusTop()Gets the radius of cylinder’s top cap.
getReceiveShadows()Gets whether this geometry can receive shadow.
getScene()Gets the scene that this object belongs to
getShearBottom()Gets of the shear transform of the bottom side, vector stores the (x-axis, z-axis) shear value that measured in radian, default value is (0, 0)
getShearTop()Gets of the shear transform of the top side, vector stores the (x-axis, z-axis) shear value that measured in radian, default value is (0, 0)
getThetaLength()Gets the length of the theta.
getThetaStart()Gets the theta start.
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.
setGenerateFanCylinder(boolean value)Sets whether to generate the fan-style cylinder when the ThetaLength is less than 2*PI, otherwise the model will not be cut.
setHeight(double value)Sets the height of the cylinder.
setHeightSegments(int value)Sets the height segments.
setName(String value)Sets the name.
setOffsetBottom(Vector3 value)Sets the vertices transformation offset of the bottom side.
setOffsetTop(Vector3 value)Sets the vertices transformation offset of the top side.
setOpenEnded(boolean value)Sets a value indicating whether this Cylinder open ended.
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
setRadialSegments(int value)Sets the radial segments.
setRadiusBottom(double value)Sets the radius of cylinder’s bottom cap.
setRadiusTop(double value)Sets the radius of cylinder’s top cap.
setReceiveShadows(boolean value)Sets whether this geometry can receive shadow.
setShearBottom(Vector2 value)Sets of the shear transform of the bottom side, vector stores the (x-axis, z-axis) shear value that measured in radian, default value is (0, 0)
setShearTop(Vector2 value)Sets of the shear transform of the top side, vector stores the (x-axis, z-axis) shear value that measured in radian, default value is (0, 0)
setThetaLength(double value)Sets the length of the theta.
setThetaStart(double value)Sets the theta start.
toMesh()Convert current object to mesh
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Cylinder()

public Cylinder()

Initializes a new instance of the Cylinder class.

Cylinder(double radius, double height)

public Cylinder(double radius, double height)

Initializes a new instance of the Cylinder class.

Parameters:

ParameterTypeDescription
radiusdoubleRadius of the top and bottom cap.
heightdoubleHeight.

Cylinder(double radiusTop, double radiusBottom, double height)

public Cylinder(double radiusTop, double radiusBottom, double height)

Initializes a new instance of the Cylinder class.

Parameters:

ParameterTypeDescription
radiusTopdoubleRadius top.
radiusBottomdoubleRadius bottom.
heightdoubleHeight.

Cylinder(double radiusTop, double radiusBottom, double height, int radialSegments, int heightSegments, boolean openEnded)

public Cylinder(double radiusTop, double radiusBottom, double height, int radialSegments, int heightSegments, boolean openEnded)

Initializes a new instance of the Cylinder class.

Parameters:

ParameterTypeDescription
radiusTopdoubleRadius of cylinder’s top cap.
radiusBottomdoubleRadius of cylinder’s bottom cap.
heightdoubleHeight of the cylinder.
radialSegmentsintRadial segments of both top and bottom circles..
heightSegmentsintHeight segments.
openEndedbooleanIf set to true the cylinder would have no bottom/top caps..

Cylinder(String name, double radiusTop, double radiusBottom, double height, int radialSegments, int heightSegments, boolean openEnded, double thetaStart, double thetaLength)

public Cylinder(String name, double radiusTop, double radiusBottom, double height, int radialSegments, int heightSegments, boolean openEnded, double thetaStart, double thetaLength)

Initializes a new instance of the Cylinder class.

Parameters:

ParameterTypeDescription
namejava.lang.StringThe name of this object
radiusTopdoubleRadius of cylinder’s top cap.
radiusBottomdoubleRadius of cylinder’s bottom cap.
heightdoubleHeight of the cylinder.
radialSegmentsintRadial segments of both top and bottom circles..
heightSegmentsintHeight segments.
openEndedbooleanIf set to true the cylinder would have no bottom/top caps..
thetaStartdoubleTheta start.
thetaLengthdoubleTheta length.

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.

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

getGenerateFanCylinder()

public boolean getGenerateFanCylinder()

Gets whether to generate the fan-style cylinder when the ThetaLength is less than 2*PI, otherwise the model will not be cut.

Returns: boolean

getHeight()

public double getHeight()

Gets the height of the cylinder.

Returns: double

getHeightSegments()

public int getHeightSegments()

Gets the height segments.

Returns: int

getName()

public String getName()

Gets the name.

Returns: java.lang.String

getOffsetBottom()

public Vector3 getOffsetBottom()

Gets the vertices transformation offset of the bottom side.

Returns: Vector3

getOffsetTop()

public Vector3 getOffsetTop()

Gets the vertices transformation offset of the top side.

Returns: Vector3

getOpenEnded()

public boolean getOpenEnded()

Gets a value indicating whether this Cylinder open ended. The default value is false.

Returns: boolean

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

getRadialSegments()

public int getRadialSegments()

Gets the radial segments.

Returns: int

getRadiusBottom()

public double getRadiusBottom()

Gets the radius of cylinder’s bottom cap.

Returns: double

getRadiusTop()

public double getRadiusTop()

Gets the radius of cylinder’s top cap.

Returns: double

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

getShearBottom()

public Vector2 getShearBottom()

Gets of the shear transform of the bottom side, vector stores the (x-axis, z-axis) shear value that measured in radian, default value is (0, 0)

Returns: Vector2

getShearTop()

public Vector2 getShearTop()

Gets of the shear transform of the top side, vector stores the (x-axis, z-axis) shear value that measured in radian, default value is (0, 0)

Returns: Vector2

getThetaLength()

public double getThetaLength()

Gets the length of the theta. The default value is 2\u03c0.

Returns: double

getThetaStart()

public double getThetaStart()

Gets the theta start. The default value is 0.

Returns: double

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

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

setGenerateFanCylinder(boolean value)

public void setGenerateFanCylinder(boolean value)

Sets whether to generate the fan-style cylinder when the ThetaLength is less than 2*PI, otherwise the model will not be cut.

Parameters:

ParameterTypeDescription
valuebooleanNew value

setHeight(double value)

public void setHeight(double value)

Sets the height of the cylinder.

Parameters:

ParameterTypeDescription
valuedoubleNew value

setHeightSegments(int value)

public void setHeightSegments(int value)

Sets the height segments.

Parameters:

ParameterTypeDescription
valueintNew value

setName(String value)

public void setName(String value)

Sets the name.

Parameters:

ParameterTypeDescription
valuejava.lang.StringNew value

setOffsetBottom(Vector3 value)

public void setOffsetBottom(Vector3 value)

Sets the vertices transformation offset of the bottom side.

Parameters:

ParameterTypeDescription
valueVector3New value

setOffsetTop(Vector3 value)

public void setOffsetTop(Vector3 value)

Sets the vertices transformation offset of the top side.

Parameters:

ParameterTypeDescription
valueVector3New value

setOpenEnded(boolean value)

public void setOpenEnded(boolean value)

Sets a value indicating whether this Cylinder open ended. The default value is false.

Parameters:

ParameterTypeDescription
valuebooleanNew 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

setRadialSegments(int value)

public void setRadialSegments(int value)

Sets the radial segments.

Parameters:

ParameterTypeDescription
valueintNew value

setRadiusBottom(double value)

public void setRadiusBottom(double value)

Sets the radius of cylinder’s bottom cap.

Parameters:

ParameterTypeDescription
valuedoubleNew value

setRadiusTop(double value)

public void setRadiusTop(double value)

Sets the radius of cylinder’s top cap.

Parameters:

ParameterTypeDescription
valuedoubleNew value

setReceiveShadows(boolean value)

public void setReceiveShadows(boolean value)

Sets whether this geometry can receive shadow.

Parameters:

ParameterTypeDescription
valuebooleanNew value

setShearBottom(Vector2 value)

public void setShearBottom(Vector2 value)

Sets of the shear transform of the bottom side, vector stores the (x-axis, z-axis) shear value that measured in radian, default value is (0, 0)

Parameters:

ParameterTypeDescription
valueVector2New value

setShearTop(Vector2 value)

public void setShearTop(Vector2 value)

Sets of the shear transform of the top side, vector stores the (x-axis, z-axis) shear value that measured in radian, default value is (0, 0)

Parameters:

ParameterTypeDescription
valueVector2New value

setThetaLength(double value)

public void setThetaLength(double value)

Sets the length of the theta. The default value is 2\u03c0.

Parameters:

ParameterTypeDescription
valuedoubleNew value

setThetaStart(double value)

public void setThetaStart(double value)

Sets the theta start. The default value is 0.

Parameters:

ParameterTypeDescription
valuedoubleNew 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