ladybug_display.geometry2d.ray module

A ray that can be displayed in 2D space.

class ladybug_display.geometry2d.ray.DisplayRay2D(geometry, color=None)[source]

Bases: _SingleColorBase2D

A ray in 2D space with display properties.

Parameters

  • geometry – A ladybug-geometry Ray2D object.

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

Properties:

  • geometry

  • color

  • p

  • v

  • user_data

ToString()
duplicate()

Get a copy of this object.

classmethod from_dict(data)[source]

Initialize a DisplayRay2D from a dictionary.

Parameters

data – A dictionary representation of an DisplayRay2D 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(normal, origin)

Reflect this geometry across a plane defined by a normal and origin.

Parameters

  • normal – A Vector2D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

  • origin – A Point2D representing the origin from which to reflect.

reverse()[source]

Reverse this DisplayRay2D.

rotate(angle, origin)

Rotate this geometry counterclockwise by a certain angle.

Parameters

  • angle – An angle for rotation in degrees.

  • origin – A Point2D for the origin around which the line segment 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 DisplayRay2D as a dictionary.

property color

Get or set a color for this object.

property geometry

Get a ladybug_geometry object.

property p

Get a Point2D representing the base of the ray.

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 v

Get a Vector2D representing the direction of the ray.