ladybug_display.geometry3d.sphere module¶
A sphere that can be displayed in 3D space.
- class ladybug_display.geometry3d.sphere.DisplaySphere(geometry, color=None, display_mode='Surface')[source]¶
Bases:
_SingleColorModeBase3D
A sphere in 3D space with display properties.
- Parameters
geometry – A ladybug-geometry Sphere.
color – A ladybug Color object. If None, a default black color will be used. (Default: None).
display_mode –
Text to indicate the display mode (surface, wireframe, etc.). Choose from the following. (Default: Surface).
Surface
SurfaceWithEdges
Wireframe
Points
- Properties:
geometry
color
display_mode
center
radius
min
max
diameter
circumference
area
volume
user_data
- ToString()¶
- duplicate()¶
Get a copy of this object.
- classmethod from_dict(data)[source]¶
Initialize a DisplaySphere from a dictionary.
- Parameters
data – A dictionary representation of an DisplaySphere object.
- move(moving_vec)¶
Move this geometry along a vector.
- Parameters
moving_vec – A ladybug_geometry Vector with the direction and distance to move the geometry.
- reflect(plane)¶
Reflect this geometry across a plane.
- Parameters
plane – A ladybug_geometry Plane across which the object will be reflected.
- rotate(axis, angle, origin)¶
Rotate this geometry by a certain angle around an axis and origin.
- Parameters
axis – A ladybug_geometry Vector3D axis representing the axis of rotation.
angle – An angle for rotation in degrees.
origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.
- rotate_xy(angle, origin)¶
Rotate this geometry counterclockwise in the world XY plane by an angle.
- Parameters
angle – An angle in degrees.
origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.
- scale(factor, origin=None)¶
Scale this geometry by a factor from an origin point.
- Parameters
factor – A number representing how much the object should be scaled.
origin – A ladybug_geometry Point representing the origin from which to scale. If None, it will be scaled from the World origin.
- property area¶
Get the surface area of the sphere.
- property center¶
Get a Point3D for the center of the sphere.
- property circumference¶
Get the circumference of the sphere.
- property color¶
Get or set a color for this object.
- property diameter¶
Get the diameter of the sphere.
- property display_mode¶
Get or set text to indicate the display mode.
- property geometry¶
Get a ladybug_geometry object.
- property max¶
Get a Point3D for the maximum of the bounding box around the object.
- property min¶
Get a Point3D for the minimum of the bounding box around the object.
- property radius¶
Get a number for the radius of the sphere.
- property user_data¶
Get or set an optional dictionary for additional meta data for this object.
This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)
- property volume¶
Get the volume of the sphere.