"""Functions to translate entire Ladybug core objects to Rhino geometries.
The methods here are intended to help translate groups of geometry that are commonly
generated by several objects in Ladybug core (ie. legends, compasses, etc.)
"""
import math
from .fromgeometry import from_point2d, from_vector2d, from_ray2d, from_linesegment2d, \
from_arc2d, from_polyline2d, from_polygon2d, from_mesh2d, \
from_point3d, from_vector3d, from_ray3d, from_linesegment3d, from_arc3d, \
from_plane, from_polyline3d, from_mesh3d, from_face3d, from_polyface3d, \
from_sphere, from_cone, from_cylinder
from .text import text_objects
try:
from ladybug_geometry.geometry2d import Vector2D, Point2D, Ray2D, LineSegment2D, \
Arc2D, Polyline2D, Polygon2D, Mesh2D
from ladybug_geometry.geometry3d import Vector3D, Point3D, Ray3D, LineSegment3D, \
Arc3D, Polyline3D, Plane, Mesh3D, Face3D, Polyface3D, Sphere, Cone, Cylinder
except ImportError as e:
raise ImportError("Failed to import ladybug_geometry.\n{}".format(e))
[docs]def legend_objects(legend):
"""Translate a Ladybug Legend object into Grasshopper geometry.
Args:
legend: A Ladybug Legend object to be converted to Rhino geometry.
Returns:
A list of Rhino geometries in the following order.
- legend_mesh -- A colored mesh for the legend.
- legend_title -- A bake-able text object for the legend title.
- legend_text -- Bake-able text objects for the rest of the legend text.
"""
_height = legend.legend_parameters.text_height
_font = legend.legend_parameters.font
legend_mesh = from_mesh3d(legend.segment_mesh)
legend_title = text_objects(legend.title, legend.title_location, _height, _font)
if legend.legend_parameters.continuous_legend is False:
legend_text = [text_objects(txt, loc, _height, _font, 0, 5) for txt, loc in
zip(legend.segment_text, legend.segment_text_location)]
elif legend.legend_parameters.vertical is True:
legend_text = [text_objects(txt, loc, _height, _font, 0, 3) for txt, loc in
zip(legend.segment_text, legend.segment_text_location)]
else:
legend_text = [text_objects(txt, loc, _height, _font, 1, 5) for txt, loc in
zip(legend.segment_text, legend.segment_text_location)]
return [legend_mesh] + [legend_title] + legend_text
[docs]def compass_objects(compass, z=0, custom_angles=None, projection=None, font='Arial'):
"""Translate a Ladybug Compass object into Grasshopper geometry.
Args:
compass: A Ladybug Compass object to be converted to Rhino geometry.
z: A number for the Z-coordinate to be used in translation. (Default: 0)
custom_angles: An array of numbers between 0 and 360 to be used to
generate custom angle labels around the compass.
projection: Text for the name of the projection to use from the sky
dome hemisphere to the 2D plane. If None, no altitude circles o
labels will be drawn (Default: None). Choose from the following:
* Orthographic
* Stereographic
font: Optional text for the font to be used in creating the text.
(Default: 'Arial')
Returns:
A list of Rhino geometries in the following order.
- all_boundary_circles -- Three Circle objects for the compass boundary.
- major_azimuth_ticks -- Line objects for the major azimuth labels.
- major_azimuth_text -- Bake-able text objects for the major azimuth labels.
- minor_azimuth_ticks -- Line objects for the minor azimuth labels
(if applicable).
- minor_azimuth_text -- Bake-able text objects for the minor azimuth
labels (if applicable).
- altitude_circles -- Circle objects for the altitude labels.
- altitude_text -- Bake-able text objects for the altitude labels.
"""
# set default variables based on the compass properties
maj_txt = compass.radius / 20
min_txt = maj_txt / 2
xaxis = Vector3D(1, 0, 0).rotate_xy(math.radians(compass.north_angle))
result = [] # list to hold all of the returned objects
for circle in compass.all_boundary_circles:
result.append(from_arc2d(circle, z))
# generate the labels and tick marks for the azimuths
if custom_angles is None:
for line in compass.major_azimuth_ticks:
result.append(from_linesegment2d(line, z))
for txt, pt in zip(compass.MAJOR_TEXT, compass.major_azimuth_points):
txt_pln = Plane(o=Point3D(pt.x, pt.y, z), x=xaxis)
result.append(text_objects(txt, txt_pln, maj_txt, font, 1, 3))
for line in compass.minor_azimuth_ticks:
result.append(from_linesegment2d(line, z))
for txt, pt in zip(compass.MINOR_TEXT, compass.minor_azimuth_points):
txt_pln = Plane(o=Point3D(pt.x, pt.y, z), x=xaxis)
result.append(text_objects(txt, txt_pln, min_txt, font, 1, 3))
else:
for line in compass.ticks_from_angles(custom_angles):
result.append(from_linesegment2d(line, z))
for txt, pt in zip(
custom_angles, compass.label_points_from_angles(custom_angles)):
txt_pln = Plane(o=Point3D(pt.x, pt.y, z), x=xaxis)
result.append(text_objects(str(txt), txt_pln, maj_txt, font, 1, 3))
# generate the labels and tick marks for the altitudes
if projection is not None:
if projection.title() == 'Orthographic':
for circle in compass.orthographic_altitude_circles:
result.append(from_arc2d(circle, z))
for txt, pt in zip(compass.ALTITUDES, compass.orthographic_altitude_points):
txt_pln = Plane(o=Point3D(pt.x, pt.y, z), x=xaxis)
result.append(text_objects(str(txt), txt_pln, min_txt, font, 1, 0))
elif projection.title() == 'Stereographic':
for circle in compass.stereographic_altitude_circles:
result.append(from_arc2d(circle, z))
for txt, pt in zip(compass.ALTITUDES, compass.stereographic_altitude_points):
txt_pln = Plane(o=Point3D(pt.x, pt.y, z), x=xaxis)
result.append(text_objects(str(txt), txt_pln, min_txt, font, 1, 0))
return result
[docs]def from_geometry(geometry):
"""Generic geometry translation function that works for any ladybug-geometry object.
This is only recommended for cases where an input geometry stream can contain
a variety of different objects. When the geometry type is know, it can be
significantly faster to use the dedicated geometry translator.
Args:
geometry: Any 2D or 3D ladybug-geometry object.
"""
if isinstance(geometry, Point3D):
return from_point3d(geometry)
elif isinstance(geometry, Vector3D):
return from_vector3d(geometry)
elif isinstance(geometry, Ray3D):
return from_ray3d(geometry)
elif isinstance(geometry, LineSegment3D):
return from_linesegment3d(geometry)
elif isinstance(geometry, Plane):
return from_plane(geometry)
elif isinstance(geometry, Arc3D):
return from_arc3d(geometry)
elif isinstance(geometry, Polyline3D):
return from_polyline3d(geometry)
elif isinstance(geometry, Mesh3D):
return from_mesh3d(geometry)
elif isinstance(geometry, Face3D):
return from_face3d(geometry)
elif isinstance(geometry, Polyface3D):
return from_polyface3d(geometry)
elif isinstance(geometry, Sphere):
return from_sphere(geometry)
elif isinstance(geometry, Cone):
return from_cone(geometry)
elif isinstance(geometry, Cylinder):
return from_cylinder(geometry)
elif isinstance(geometry, Point2D):
return from_point2d(geometry)
elif isinstance(geometry, Vector2D):
return from_vector2d(geometry)
elif isinstance(geometry, Ray2D):
return from_ray2d(geometry)
elif isinstance(geometry, LineSegment2D):
return from_linesegment2d(geometry)
elif isinstance(geometry, Arc2D):
return from_arc2d(geometry)
elif isinstance(geometry, Polygon2D):
return from_polygon2d(geometry)
elif isinstance(geometry, Polyline2D):
return from_polyline2d(geometry)
elif isinstance(geometry, Mesh2D):
return from_mesh2d(geometry)