honeybee_vtk.to_vtk module

Functions to translate HB Model objects to PolyData or JoinedPolyData.

honeybee-vtk provides a wrapper for vtkPolyData or vtkAppendPolyData which are used instead of the original objects to add additional fields that are needed to provide additional functionalities in honeybee-vtk. See types module for more information.

There are two sets of functions in this module:

  • create_xThese methods create an object from other objects. For instance

    create_polyline creates a polyline for a list of points.

  • convert_x: These methods convert a LBT object directly to a PolyData. For instance

    convert_polyline converts a Polyline3D to a VTK-based Polyline.

honeybee_vtk.to_vtk.convert_aperture(aperture: honeybee.aperture.Aperture) → List[honeybee_vtk.types.PolyData][source]
honeybee_vtk.to_vtk.convert_door(door: honeybee.door.Door) → List[honeybee_vtk.types.PolyData][source]
honeybee_vtk.to_vtk.convert_face(face: honeybee.face.Face) → List[honeybee_vtk.types.PolyData][source]

Convert a HBFace to a PolyData.

honeybee_vtk.to_vtk.convert_face_3d(face: ladybug_geometry.geometry3d.face.Face3D)honeybee_vtk.types.PolyData[source]

Convert a ladybug_geometry.Face3D to vtkPolyData.

honeybee_vtk.to_vtk.convert_mesh(mesh: ladybug_geometry.geometry3d.mesh.Mesh3D)honeybee_vtk.types.PolyData[source]

Convert a ladybug_geometry.Mesh to vtkPolyData.

honeybee_vtk.to_vtk.convert_points(points: List[ladybug_geometry.geometry3d.pointvector.Point3D])honeybee_vtk.types.PolyData[source]

Export a list of points to VTK.

Parameters

points – A list of Point3D.

Returns

A vtk object with multiple VTK point objects.

honeybee_vtk.to_vtk.convert_polyline(polyline: ladybug_geometry.geometry3d.polyline.Polyline3D)honeybee_vtk.types.PolyData[source]
honeybee_vtk.to_vtk.convert_room(room: honeybee.room.Room) → List[honeybee_vtk.types.PolyData][source]

Convert HB Room to PolyData.

honeybee_vtk.to_vtk.convert_sensor_grid(sensor_grid: honeybee_radiance.sensorgrid.SensorGrid, load_option: honeybee_vtk.vtkjs.schema.SensorGridOptions = <SensorGridOptions.Mesh: 2>, angle: int = None, radius: float = None)honeybee_vtk.types.PolyData[source]

Convert a honeybee-radiance sensor grid to a vtkPolyData.

honeybee_vtk.to_vtk.convert_shade(shade: honeybee.shade.Shade)honeybee_vtk.types.PolyData[source]
honeybee_vtk.to_vtk.create_arrow(start_points: List[ladybug_geometry.geometry3d.pointvector.Point3D], vectors: List[ladybug_geometry.geometry3d.pointvector.Vector3D])honeybee_vtk.types.JoinedPolyData[source]

Create arrows from point and vector.

honeybee_vtk.to_vtk.create_polyline(points: List[ladybug_geometry.geometry3d.pointvector.Point3D])honeybee_vtk.types.PolyData[source]

Create a polyline from a list of points.