Frame

Public Class

A Frame comprises three vectors at a base point in 3D space.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Frame

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class Frame : IDisposable

The Frame type exposes the following members.

Constructors

Name

Description

Public Method
Frame.

Default constructor. Uses global origin and standard basis vectors.

Public Method
Frame(XYZ, XYZ, XYZ, XYZ)

Constructor that takes the frame’s base point and three basis vectors.

Properties

Name

Description

Public Property

BasisX

The first basis vector of the frame.

Public Property

BasisY

The second basis vector of the frame.

Public Property

BasisZ

The third basis vector of the frame.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Public Property

Origin

The frame’s base point.

Methods

Name

Description

Public Method
Static Member
CanDefineRevitGeometry

Tests whether the supplied Frame object may be used to define a Revit curve or surface. In order to satisfy the requirements the Frame must be orthonormal and its origin is expected to lie within the Revit design limits IsWithinLengthLimits(XYZ).

Public Method

Dispose

Releases all resources used by the Frame

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

IsOrthogonal

Determines if this frame’s basis vectors are orthogonal.

Public Method
IsOrthonormal

Determines if this frame’s basis vectors are orthonormal.

Public Method
IsRightHanded

Determine if this frame’s basis is right-handed.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Public Method

Transform

Applies the input transform to this frame.

Remarks

A Frame consists of three vectors at a base point in 3D space. The vectors need not be orthogonal, have unit length, or even be linearly independent, although in practice Frames will usually have linearly independent vectors. Frames may be used to represent a coordinate frame of reference, a moving frame field on a curve, or for other purposes.