ladybug_display.geometry3d.arc module

An arc that can be displayed in 3D space.

class ladybug_display.geometry3d.arc.DisplayArc3D(geometry, color=None, line_width=Default, line_type='Continuous')[source]

Bases: _LineCurveBase3D

An arc in 3D space with display properties.

Parameters:

  • geometry – A ladybug-geometry Arc3D object.

  • color – A ladybug Color object. If None, a default black color will be used. (Default: None).

  • line_width – Number for line width in pixels (for the screen). For print, this will be converted a value in millimeters or inches assuming standard web resolution (72 pixels per inch). This can also be the Default object to indicate that the default settings of the interface should be used (typically one pixel).

  • line_type –

    Get or set text to indicate the type of line to display. Choose from the following. (Default: “Continuous”)

    • Continuous

    • Dashed

    • Dotted

    • DashDot

Properties:

  • geometry

  • color

  • line_width

  • line_type

  • plane

  • radius

  • p1

  • p2

  • c

  • angle

  • length

  • is_circle

  • user_data

ToString()
duplicate()

Get a copy of this object.

classmethod from_dict(data)[source]

Initialize a DisplayArc3D from a dictionary.

Parameters:

data – A dictionary representation of an DisplayArc3D 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.

to_dict()[source]

Return DisplayArc3D as a dictionary.

property angle

The total angle over the domain of the arc in degrees.

property c

Get a Point3D representing the center of the arc.

property color

Get or set a color for this object.

property geometry

Get a ladybug_geometry object.

property is_circle

Get a boolean for whether the arc is a circle.

property length

Get a number for the length of the arc.

property line_type

Get or set text to indicate the type of line to display.

property line_width

Get or set a number to indicate the width of the line in pixels.

property p1

Get a Point3D representing the first end point of the arc.

property p2

Get a Point3D representing the second end point of the arc.

property plane

Get a Plane which the arc lies with an origin representing the center.

property radius

Get a number for the radius of the arc.

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)