Namespace: Autodesk.Revit.DB Class: Plane

Plane.CreateByNormalAndOrigin

Method

Description:
Constructs a Plane object from a normal and an origin represented as XYZ objects. Follows the standard conventions for a planar surface. The constructed Plane object will pass through origin and be perpendicular to normal.

Remarks:
This function does not guarantee a specific parameterization of the created Plane. Use Plane.Create(Frame) to enforce a specific parameterization of the created Plane object.

Syntax

public static Plane CreateByNormalAndOrigin(
	XYZ normal,
	XYZ origin
)

Public Shared Function CreateByNormalAndOrigin ( 
	normal As XYZ,
	origin As XYZ
) As Plane

public:
static Plane^ CreateByNormalAndOrigin(
	XYZ^ normal, 
	XYZ^ origin
)

static member CreateByNormalAndOrigin : 
        normal : XYZ * 
        origin : XYZ -> Plane

Examples

 // Create a geometry plane in Revit application
XYZ normal = XYZ.BasisZ;    // use basis of the z-axis (0,0,1) for normal vector 
XYZ origin = XYZ.Zero;  // origin is (0,0,0)  
Plane geomPlane = Plane.CreateByNormalAndOrigin(normal, origin);

   ' Create a geometry plane in Revit application
   Dim normal As XYZ = XYZ.BasisZ
   ' use basis of the z-axis (0,0,1) for normal vector 
   Dim origin As XYZ = XYZ.Zero
   ' origin is (0,0,0)  
Dim geomPlane As Plane = Plane.CreateByNormalAndOrigin(normal, origin)

Parameters

Parameter	Type	Description
normal	XYZ	Plane normal. Expected to be a valid non-zero length vector. Doesn't need to be a unit vector.
origin	XYZ	Plane origin. Expected to lie within the Revit design limits <a href="ac2171af-4250-8a30-faa7-4d7030d29a03.htm">IsWithinLengthLimits(XYZ)</a>.

Return Value

Plane

Exceptions

Exception	Condition
ArgumentException	The input point lies outside of Revit design limits.
ArgumentNullException	A non-optional argument was null
ArgumentOutOfRangeException	normal has zero length.