PlanarSurface

class compas.geometry.PlanarSurface[source]

Bases: Surface

A planar surface is defined by a local coordinate system and a size.

Parameters:
framecompas.geometry.Frame, optional

The local coordinate system of the surface. Default is None, in which case the world coordinate system is used.

xsizefloat, optional

The size of the surface in the local X-direction.

ysizefloat, optional

The size of the surface in the local Y-direction.

namestr, optional

The name of the surface.

Methods

frame_at

Construct a frame at a point on the planar surface.

from_plane_and_size

Construct a planar surface from a plane and x and y sizes.

normal_at

Construct the normal at a point on the planar surface.

point_at

Construct a point on the planar surface.

to_plane

Convert the planar surface to a plane.

Inherited Methods

ToString

Converts the instance to a string.

aabb

Compute the axis aligned bounding box of the surface.

boundary

Compute the boundary curves of the surface.

closest_point

Compute the closest point on the curve to a given point.

compute_aabb

Compute the axis-aligned bounding box of the geometry.

compute_obb

Compute the oriented bounding box of the geometry.

copy

Make an independent copy of the data object.

curvature_at

Compute the curvature at a point on the surface.

from_json

Construct an object of this type from a JSON file.

from_jsonstring

Construct an object of this type from a JSON string.

from_obj

Load a surface from an OBJ file.

from_plane

Construct a surface from a plane.

from_step

Load a surface from a STP file.

intersections_with_curve

Compute the intersections with a curve.

intersections_with_line

Compute the intersections with a line.

intersections_with_plane

Compute the intersections with a plane.

isocurve_u

Compute the isoparametric curve at parameter u.

isocurve_v

Compute the isoparametric curve at parameter v.

obb

Compute the oriented bounding box of the surface.

pointgrid

Compute point locations corresponding to evenly spaced parameters over the surface domain.

rotate

Rotate the geometry.

rotated

Returns a rotated copy of this geometry.

scale

Scale the geometry.

scaled

Returns a scaled copy of this geometry.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

space_u

Compute evenly spaced parameters over the surface domain in the U direction.

space_v

Compute evenly spaced parameters over the surface domain in the V direction.

to_brep

Convert the surface to a BREP representation.

to_json

Convert an object to its native data representation and save it to a JSON file.

to_jsonstring

Convert an object to its native data representation and save it to a JSON string.

to_mesh

Convert the surface to a mesh.

to_polyhedron

Convert the surface to a polyhedron.

to_quads

Convert the surface to a list of quads.

to_step

Write the surface geometry to a STP file.

to_tesselation

Convert the surface to a triangle mesh.

to_triangles

Convert the surface to a list of triangles.

to_vertices_and_faces

Convert the surface to a list of vertices and faces.

transform

Transform the local coordinate system of the surface.

transformed

Returns a transformed copy of this geometry.

translate

Translate the geometry.

translated

Returns a translated copy of this geometry.

validate_data

Validate the data against the object's data schema.