Skip to main content
Ctrl+K
This is the WIP documentation for the pre-release of COMPAS 2.0. The documentation of COMPAS 1.17.5 is available here.
Logo image

COMPAS docs

Site Navigation

  • User Guide
  • Package Reference
  • Developer Guide
  • Extensions
  • COMPAS Framework

Site Navigation

  • User Guide
  • Package Reference
  • Developer Guide
  • Extensions
  • COMPAS Framework
  • compas
    • compas.artists
      • Artist
      • GeometryArtist
      • MeshArtist
      • NetworkArtist
      • VolMeshArtist
      • DataArtistNotRegistered
      • NoArtistContextError
    • compas.colors
      • Color
      • ColorDict
      • ColorMap
    • compas.data
      • Data
      • DataEncoder
      • DataDecoder
      • is_float3
      • is_float4x4
      • is_int3
      • is_item_iterable
      • is_sequence_of_float
      • is_sequence_of_int
      • is_sequence_of_uint
      • json_load
      • json_loads
      • json_dump
      • json_dumps
      • DecoderError
    • compas.datastructures
      • Datastructure
      • Graph
      • HalfEdge
      • HalfFace
      • Mesh
      • Network
      • VolMesh
      • Assembly
      • Part
      • Feature
      • GeometricFeature
      • ParametricFeature
      • AssemblyError
      • FeatureError
      • network_adjacency_matrix
      • network_complement
      • network_connectivity_matrix
      • network_count_crossings
      • network_degree_matrix
      • network_disconnected_edges
      • network_disconnected_nodes
      • network_embed_in_plane_proxy
      • network_embed_in_plane
      • network_explode
      • network_find_crossings
      • network_find_cycles
      • network_is_connected
      • network_is_crossed
      • network_is_planar_embedding
      • network_is_planar
      • network_is_xy
      • network_join_edges
      • network_laplacian_matrix
      • network_polylines
      • network_shortest_path
      • network_smooth_centroid
      • network_split_edge
      • network_transform
      • network_transformed
      • mesh_add_vertex_to_face_edge
      • mesh_adjacency_matrix
      • mesh_bounding_box_xy
      • mesh_bounding_box
      • mesh_collapse_edge
      • mesh_connected_components
      • mesh_connectivity_matrix
      • mesh_contours_numpy
      • mesh_conway_ambo
      • mesh_conway_bevel
      • mesh_conway_dual
      • mesh_conway_expand
      • mesh_conway_gyro
      • mesh_conway_join
      • mesh_conway_kis
      • mesh_conway_meta
      • mesh_conway_needle
      • mesh_conway_ortho
      • mesh_conway_snub
      • mesh_conway_truncate
      • mesh_conway_zip
      • mesh_degree_matrix
      • mesh_delete_duplicate_vertices
      • mesh_disconnected_faces
      • mesh_disconnected_vertices
      • mesh_dual
      • mesh_explode
      • mesh_face_adjacency
      • mesh_face_matrix
      • mesh_flatness
      • mesh_flip_cycles
      • mesh_geodesic_distances_numpy
      • mesh_insert_vertex_on_edge
      • mesh_is_connected
      • mesh_isolines_numpy
      • mesh_laplacian_matrix
      • mesh_merge_faces
      • mesh_offset
      • mesh_oriented_bounding_box_numpy
      • mesh_oriented_bounding_box_xy_numpy
      • mesh_planarize_faces
      • mesh_quads_to_triangles
      • mesh_slice_plane
      • mesh_smooth_area
      • mesh_smooth_centerofmass
      • mesh_smooth_centroid
      • mesh_split_edge
      • mesh_split_face
      • mesh_split_strip
      • mesh_subdivide_catmullclark
      • mesh_subdivide_corner
      • mesh_subdivide_doosabin
      • mesh_subdivide_frames
      • mesh_subdivide_quad
      • mesh_subdivide_tri
      • mesh_subdivide
      • mesh_substitute_vertex_in_faces
      • mesh_thicken
      • mesh_transform
      • mesh_transform_numpy
      • mesh_transformed
      • mesh_transformed_numpy
      • mesh_unify_cycles
      • mesh_unweld_edges
      • mesh_unweld_vertices
      • mesh_weld
      • meshes_join_and_weld
      • meshes_join
      • trimesh_collapse_edge
      • trimesh_cotangent_laplacian_matrix
      • trimesh_descent
      • trimesh_face_circle
      • trimesh_gaussian_curvature
      • trimesh_mean_curvature
      • trimesh_pull_points_numpy
      • trimesh_remesh
      • trimesh_samplepoints_numpy
      • trimesh_smooth_laplacian_cotangent
      • trimesh_split_edge
      • trimesh_subdivide_loop
      • trimesh_swap_edge
      • trimesh_vertexarea_matrix
      • volmesh_bounding_box
      • volmesh_transform
      • volmesh_transformed
    • compas.files
      • DXF
      • DXFParser
      • DXFReader
      • GLTF
      • GLTFContent
      • GLTFExporter
      • GLTFMesh
      • GLTFParser
      • GLTFReader
      • LAS
      • LASParser
      • LASReader
      • OBJ
      • OBJParser
      • OBJReader
      • OBJWriter
      • OFF
      • OFFReader
      • OFFWriter
      • PLY
      • PLYParser
      • PLYReader
      • PLYWriter
      • STL
      • STLParser
      • STLReader
      • STLWriter
      • URDF
      • URDFElement
      • URDFGenericElement
      • URDFParser
      • XML
      • XMLElement
      • XMLReader
      • XMLWriter
    • compas.geometry
      • Curve
      • Geometry
      • Surface
      • Transformation
      • Arc
      • Bezier
      • Box
      • Brep
      • BrepEdge
      • BrepFace
      • BrepLoop
      • BrepVertex
      • Capsule
      • Circle
      • Cone
      • ConicalSurface
      • Cylinder
      • CylindricalSurface
      • Ellipse
      • Frame
      • Hyperbola
      • KDTree
      • Line
      • NurbsCurve
      • NurbsSurface
      • Plane
      • PlanarSurface
      • Point
      • Pointcloud
      • Polyhedron
      • Polyline
      • Projection
      • Reflection
      • Rotation
      • Scale
      • Shear
      • Sphere
      • SphericalSurface
      • ToroidalSurface
      • Torus
      • Translation
      • Vector
      • bestfit_circle_numpy
      • bestfit_frame_numpy
      • bestfit_line_numpy
      • bestfit_plane
      • bestfit_plane_numpy
      • bestfit_sphere_numpy
      • boolean_difference_mesh_mesh
      • boolean_difference_polygon_polygon
      • boolean_intersection_mesh_mesh
      • boolean_intersection_polygon_polygon
      • boolean_symmetric_difference_polygon_polygon
      • boolean_union_mesh_mesh
      • boolean_union_polygon_polygon
      • bounding_box
      • bounding_box_xy
      • conforming_delaunay_triangulation
      • constrained_delaunay_triangulation
      • convex_hull
      • convex_hull_numpy
      • convex_hull_xy
      • convex_hull_xy_numpy
      • delaunay_from_points
      • delaunay_from_points_numpy
      • delaunay_triangulation
      • discrete_coons_patch
      • earclip_polygon
      • icp_numpy
      • intersection_line_line
      • intersection_segment_segment
      • intersection_line_segment
      • intersection_line_plane
      • intersection_segment_plane
      • intersection_polyline_plane
      • intersection_line_triangle
      • intersection_plane_plane
      • intersection_plane_plane_plane
      • intersection_sphere_sphere
      • intersection_segment_polyline
      • intersection_sphere_line
      • intersection_plane_circle
      • intersection_line_line_xy
      • intersection_line_segment_xy
      • intersection_line_box_xy
      • intersection_polyline_box_xy
      • intersection_segment_segment_xy
      • intersection_circle_circle_xy
      • intersection_segment_polyline_xy
      • intersection_ellipse_line_xy
      • offset_line
      • offset_polygon
      • offset_polyline
      • oriented_bounding_box_numpy
      • oriented_bounding_box_xy_numpy
      • quadmesh_planarize
      • trimesh_descent_numpy
      • trimesh_gaussian_curvature
      • trimesh_geodistance
      • trimesh_gradient_numpy
      • trimesh_harmonic
      • trimesh_isolines
      • trimesh_lscm
      • trimesh_massmatrix
      • trimesh_mean_curvature
      • trimesh_principal_curvature
      • trimesh_remesh
      • trimesh_remesh_constrained
      • trimesh_remesh_along_isoline
      • trimesh_slice
      • tween_points
      • tween_points_distance
      • voronoi_from_points_numpy
      • add_vectors
      • add_vectors_xy
      • allclose
      • angle_planes
      • angle_points
      • angle_points_xy
      • angle_vectors
      • angle_vectors_signed
      • angle_vectors_xy
      • angles_points
      • angles_points_xy
      • angles_vectors
      • angles_vectors_xy
      • argmax
      • argmin
      • centroid_points
      • centroid_points_xy
      • centroid_points_weighted
      • centroid_polygon
      • centroid_polygon_edges
      • centroid_polygon_edges_xy
      • centroid_polygon_vertices
      • centroid_polygon_vertices_xy
      • centroid_polygon_xy
      • centroid_polyhedron
      • close
      • closest_point_in_cloud
      • closest_point_in_cloud_xy
      • closest_point_on_line
      • closest_point_on_line_xy
      • closest_point_on_plane
      • closest_point_on_polygon_xy
      • closest_point_on_polyline
      • closest_point_on_polyline_xy
      • closest_point_on_segment
      • closest_point_on_segment_xy
      • closest_points_in_cloud_numpy
      • compose_matrix
      • cross_vectors
      • cross_vectors_xy
      • decompose_matrix
      • dehomogenize_vectors
      • distance_line_line
      • distance_point_line
      • distance_point_line_sqrd
      • distance_point_line_sqrd_xy
      • distance_point_line_xy
      • distance_point_plane
      • distance_point_plane_signed
      • distance_point_point
      • distance_point_point_sqrd
      • distance_point_point_sqrd_xy
      • distance_point_point_xy
      • divide_vectors
      • divide_vectors_xy
      • dot_vectors
      • dot_vectors_xy
      • homogenize_vectors
      • identity_matrix
      • is_ccw_xy
      • is_colinear
      • is_colinear_line_line
      • is_colinear_xy
      • is_coplanar
      • is_intersection_line_line
      • is_intersection_line_line_xy
      • is_intersection_line_plane
      • is_intersection_line_triangle
      • is_intersection_plane_plane
      • is_intersection_segment_plane
      • is_intersection_segment_segment
      • is_intersection_segment_segment_xy
      • is_matrix_square
      • is_parallel_line_line
      • is_point_behind_plane
      • is_point_in_box
      • is_point_in_circle
      • is_point_in_circle_xy
      • is_point_in_convex_polygon_xy
      • is_point_in_polygon_xy
      • is_point_in_polyhedron
      • is_point_in_triangle
      • is_point_in_triangle_xy
      • is_point_infront_plane
      • is_point_on_line
      • is_point_on_line_xy
      • is_point_on_plane
      • is_point_on_polyline
      • is_point_on_polyline_xy
      • is_point_on_segment
      • is_point_on_segment_xy
      • is_polygon_convex
      • is_polygon_convex_xy
      • is_polygon_in_polygon_xy
      • length_vector
      • length_vector_sqrd
      • length_vector_sqrd_xy
      • length_vector_xy
      • matrix_determinant
      • matrix_from_change_of_basis
      • matrix_from_euler_angles
      • matrix_from_frame
      • matrix_from_frame_to_frame
      • matrix_inverse
      • matrix_minor
      • midpoint_line
      • midpoint_line_xy
      • midpoint_point_point
      • midpoint_point_point_xy
      • multiply_matrices
      • multiply_matrix_vector
      • multiply_vectors
      • multiply_vectors_xy
      • norm_vector
      • norm_vectors
      • normalize_vector
      • normalize_vector_xy
      • normalize_vectors
      • normalize_vectors_xy
      • orthonormalize_vectors
      • power_vector
      • power_vectors
      • scale_vector
      • scale_vector_xy
      • scale_vectors
      • scale_vectors_xy
      • sort_points
      • sort_points_xy
      • square_vector
      • square_vectors
      • subtract_vectors
      • subtract_vectors_xy
      • sum_vectors
      • transpose_matrix
      • vector_average
      • vector_component
      • vector_component_xy
      • vector_variance
      • vector_standard_deviation
    • compas.numerical
      • pca_numpy
      • scalarfield_contours_numpy
      • nullspace
      • rank
      • dof
      • pivots
      • nonpivots
      • rref
      • rref_sympy
      • rref_matlab
      • chofactor
      • lufactorized
      • uvw_lengths
      • normrow
      • normalizerow
      • rot90
      • solve_with_known
      • spsolve_with_known
      • adjacency_matrix
      • connectivity_matrix
      • degree_matrix
      • equilibrium_matrix
      • face_matrix
      • laplacian_matrix
      • mass_matrix
      • stiffness_matrix
    • compas.plugins
      • pluggable
      • plugin
      • PluginManager
      • IncompletePluginImplError
      • PluginNotInstalledError
    • compas.rpc
      • Dispatcher
      • Proxy
      • Server
      • RPCClientError
      • RPCServerError
    • compas.topology
      • adjacency_from_edges
      • astar_lightest_path
      • astar_shortest_path
      • breadth_first_ordering
      • breadth_first_traverse
      • breadth_first_paths
      • connected_components
      • depth_first_ordering
      • dijkstra_distances
      • dijkstra_path
      • face_adjacency
      • face_adjacency_numpy
      • shortest_path
      • unify_cycles
      • unify_cycles_numpy
      • vertex_coloring
  • compas_blender
    • compas_blender.artists
      • BoxArtist
      • CapsuleArtist
      • CircleArtist
      • ConeArtist
      • CurveArtist
      • CylinderArtist
      • FrameArtist
      • LineArtist
      • MeshArtist
      • NetworkArtist
      • PointArtist
      • PointcloudArtist
      • PolygonArtist
      • PolyhedronArtist
      • PolylineArtist
      • SphereArtist
      • SurfaceArtist
      • TorusArtist
      • VectorArtist
      • VolMeshArtist
      • BlenderArtist
    • compas_blender.conversions
      • bmesh_to_compas
      • circle_to_blender_curve
      • color_to_blender_material
      • cylinder_to_blender_mesh
      • line_to_blender_curve
      • mesh_to_blender
      • mesh_to_compas
      • monkey_to_compas
      • nurbscurve_to_blender_curve
      • nurbssurface_to_blender_surface
      • pointcloud_to_blender
      • polygon_to_blender_mesh
      • polyline_to_blender_curve
      • sphere_to_blender_mesh
      • transformation_to_blender
      • transformation_to_compas
      • vertices_and_faces_to_blender_mesh
    • compas_blender.geometry
  • compas_ghpython
    • compas_ghpython.artists
      • BoxArtist
      • BrepArtist
      • CapsuleArtist
      • CircleArtist
      • ConeArtist
      • CurveArtist
      • CylinderArtist
      • FrameArtist
      • LineArtist
      • MeshArtist
      • NetworkArtist
      • PointArtist
      • PolygonArtist
      • PolyhedronArtist
      • PolylineArtist
      • SphereArtist
      • SurfaceArtist
      • TorusArtist
      • VectorArtist
      • VolMeshArtist
      • GHArtist
  • compas_rhino
    • compas_rhino.artists
      • BoxArtist
      • BrepArtist
      • CapsuleArtist
      • CircleArtist
      • ConeArtist
      • CurveArtist
      • CylinderArtist
      • FrameArtist
      • LineArtist
      • MeshArtist
      • NetworkArtist
      • PlaneArtist
      • PointArtist
      • PolygonArtist
      • PolyhedronArtist
      • PolylineArtist
      • SphereArtist
      • SurfaceArtist
      • TorusArtist
      • VectorArtist
      • VolMeshArtist
      • RhinoArtist
    • compas_rhino.conversions
      • ConversionError
      • arc_to_compas
      • arc_to_rhino
      • box_to_compas
      • box_to_rhino
      • brep_to_compas_box
      • brep_to_compas_cone
      • brep_to_compas_cylinder
      • brep_to_compas_sphere
      • brep_to_rhino
      • capsule_to_rhino_brep
      • circle_to_compas
      • circle_to_rhino
      • circle_to_rhino_curve
      • cone_to_compas
      • cone_to_rhino
      • cone_to_rhino_brep
      • curve_to_compas_circle
      • curve_to_compas_ellipse
      • curve_to_compas_line
      • curve_to_compas_polyline
      • curve_to_rhino
      • cylinder_to_compas
      • cylinder_to_rhino
      • cylinder_to_rhino_brep
      • ellipse_to_compas
      • ellipse_to_rhino
      • ellipse_to_rhino_curve
      • extrusion_to_compas_box
      • extrusion_to_compas_cylinder
      • extrusion_to_compas_torus
      • frame_to_rhino
      • frame_to_rhino_plane
      • line_to_compas
      • line_to_rhino
      • line_to_rhino_curve
      • mesh_to_compas
      • mesh_to_rhino
      • plane_to_compas
      • plane_to_compas_frame
      • plane_to_rhino
      • point_to_compas
      • point_to_rhino
      • polygon_to_compas
      • polygon_to_rhino
      • polyhedron_to_rhino
      • polyline_to_compas
      • polyline_to_rhino
      • polyline_to_rhino_curve
      • sphere_to_compas
      • sphere_to_rhino
      • surface_to_compas
      • surface_to_compas_data
      • surface_to_compas_mesh
      • surface_to_compas_quadmesh
      • surface_to_rhino
      • torus_to_rhino
      • torus_to_rhino_brep
      • transformation_to_rhino
      • transformation_matrix_to_rhino
      • vector_to_compas
      • vector_to_rhino
      • vertices_and_faces_to_rhino
    • compas_rhino.forms
      • BrowserForm
      • ChartForm
      • ImageForm
      • SliderForm
      • TextForm
      • BaseForm
    • compas_rhino.geometry
      • RhinoBrep
      • RhinoBrepEdge
      • RhinoBrepFace
      • RhinoBrepLoop
      • RhinoBrepTrim
      • RhinoBrepVertex
      • RhinoNurbsCurve
      • RhinoNurbsSurface
      • boolean_difference_mesh_mesh
      • boolean_intersection_mesh_mesh
      • boolean_union_mesh_mesh
      • new_curve
      • new_nurbscurve
      • new_nurbscurve_from_interpolation
      • new_nurbscurve_from_parameters
      • new_nurbscurve_from_points
      • new_nurbscurve_from_step
      • trimesh_gaussian_curvature
      • trimesh_mean_curvature
      • trimesh_principal_curvature
      • trimesh_slice

compas

This package is the core package of the COMPAS framework. It defines all functionality for geometry processing, data structures, topology, numerical methods, robotics, the plugin mechanism, remote procedure calls … and can be used independently of CAD systems in any environment that supports Python programming.

Modules

  • compas.artists
  • compas.colors
  • compas.data
  • compas.datastructures
  • compas.files
  • compas.geometry
  • compas.numerical
  • compas.plugins
  • compas.rpc
  • compas.topology

previous

Package Reference

next

compas.artists

On this page
  • Modules
Edit on GitHub

© Copyright COMPAS Association.

Created using Sphinx 4.5.0.

Built with the PyData Sphinx Theme 0.13.3.