Cylinder class

Cylinder class

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

Inheritance: CylinderPrimitiveEntitySceneObjectA3DObject

The Cylinder type exposes the following members:

Constructors

ConstructorDescription
__init__(self)Initializes a new instance of the Cylinder class.
__init__(self, radius, height)Initializes a new instance of the Cylinder class.
__init__(self, radius_top, radius_bottom, height)Initializes a new instance of the Cylinder class.
__init__(self, radius_top, radius_bottom, height, radial_segments, height_segments, open_ended)Initializes a new instance of the Cylinder class.
__init__(self, name, radius_top, radius_bottom, height, radial_segments, height_segments, open_ended, theta_start, theta_length)Initializes a new instance of the Cylinder class.

Properties

PropertyDescription
nameGets or sets the name.
propertiesGets the collection of all properties.
sceneGets the scene that this object belongs to
parent_nodesGets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
excludedGets or sets whether to exclude this entity during exporting.
parent_nodeGets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
cast_shadowsGets or sets whether this geometry can cast shadow
receive_shadowsGets or sets whether this geometry can receive shadow.
offset_bottomGets or sets the vertices transformation offset of the bottom side.
offset_topGets or sets the vertices transformation offset of the top side.
generate_fan_cylinderGets or sets whether to generate the fan-style cylinder when the ThetaLength is less than 2*PI, otherwise the model will not be cut.
shear_bottomGets or 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)
shear_topGets or 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)
radius_topGets or sets the radius of cylinder’s top cap.
radius_bottomGets or sets the radius of cylinder’s bottom cap.
heightGets or sets the height of the cylinder.
radial_segmentsGets or sets the radial segments.
height_segmentsGets or sets the height segments.
open_endedGets or sets a value indicating whether this Cylinder open ended.
The default value is false.
theta_startGets or sets the theta start.
The default value is 0.
theta_lengthGets or sets the length of the theta.
The default value is 2π.

Methods

MethodDescription
remove_property(self, property)Removes a dynamic property.
remove_property(self, property)Remove the specified property identified by name
get_property(self, property)Get the value of specified property
set_property(self, property, value)Sets the value of specified property
find_property(self, property_name)Finds the property.
It can be a dynamic property (Created by CreateDynamicProperty/SetProperty)
or native property(Identified by its name)
get_bounding_box(self)Gets the bounding box of current entity in its object space coordinate system.
get_entity_renderer_key(self)Gets the key of the entity renderer registered in the renderer
to_mesh(self)Convert current object to mesh

See Also