Frame
- class compas.geometry.Frame(point, xaxis, yaxis, **kwargs)[source]
Bases:
Primitive
A frame is defined by a base point and two orthonormal base vectors.
- Parameters
- Attributes
point (
Point
) – The base point of the frame.xaxis (
Vector
) – The local X axis of the frame.yaxis (
Vector
) – The local Y axis of the frame.zaxis (
Vector
, read-only) – The Z axis of the frame.normal (
Vector
, read-only) – The normal of the base plane of the frame.quaternion (
Quaternion
, read-only) – The quaternion from the rotation given by the frame.axis_angle_vector (
Vector
, read-only) – The axis-angle vector representing the rotation of the frame.
Notes
All input vectors are orthonormalized when creating a frame, with the first vector as starting point.
Examples
>>> from compas.geometry import Point >>> from compas.geometry import Vector >>> f = Frame([0, 0, 0], [1, 0, 0], [0, 1, 0]) >>> f = Frame(Point(0, 0, 0), Vector(1, 0, 0), Vector(0, 1, 0))
Methods
The Euler angles from the rotation given by the frame.
Construct a frame from an axis-angle vector representing the rotation.
Construct a frame from its data representation.
Construct a frame from a rotation represented by Euler angles.
Construct a frame from a list of 12 or 16 float values.
Construct a frame from a matrix.
Constructs a frame from a plane.
Constructs a frame from 3 points.
Construct a frame from a rotation represented by quaternion coefficients.
Constructs a frame from a Rotation.
Constructs a frame from a Transformation.
Returns the object's coordinates in frame1 in the local coordinates of frame2.
Returns the object's coordinates in the local coordinate system of the frame.
Returns the object's coordinates in the global coordinate frame.
Transform the frame.
Construct the world XY frame.
Construct the world YZ frame.
Construct the world ZX frame.
Inherited Methods
Converts the instance to a string.
Make an independent copy of the data object.
Construct an object from serialized data contained in a JSON file.
Construct an object from serialized data contained in a JSON string.
Compute a hash of the data for comparison during version control using the sha256 algorithm.
Convert an object to its native data representation.
Serialize the data representation of an object to a JSON file.
Serialize the data representation of an object to a JSON string.
Returns a transformed copy of this geometry.
Validate the object's data against its data schema.
Validate the object's data against its json schema.