Plane class

Plane class

Parameterized plane.

Inheritance: PlanePrimitiveEntitySceneObjectA3DObject

The Plane type exposes the following members:

Constructors

ConstructorDescription
__init__(self)Initializes a new instance of the Plane with default size 1x1.
__init__(self, length, width)Initializes a new instance of the Plane.
__init__(self, name, length, width, length_segments, width_segments)Initializes a new instance of the Plane.

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.
upGets or sets the up vector of the plane, default value is (0, 1, 0), this affects the generation of the plane
lengthGets or sets the length of the plane.
widthGets or sets the width of the plane.
length_segmentsGets or sets the length segments.
width_segmentsGets or sets the width segments.

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