Application.NewPointOnPlane
Method
Description:
Construct a PointOnPlane object which is used to define the placement of a ReferencePoint from its property values.
Construct a PointOnPlane object which is used to define the placement of a ReferencePoint from its property values.
Syntax
public PointOnPlane NewPointOnPlane(
Reference planeReference,
UV position,
UV xvec,
double offset
)
Parameters
Parameter | Type | Description |
---|---|---|
planeReference | Reference | A reference to some plane in the document. (Note: the reference must satisfy IsValidPlaneReference(), but this is not checked until this PointOnPlane object is assigned to a ReferencePoint.) |
position | UV | Coordinates of the point's projection onto the plane; see the Position property. |
xvec | UV | The direction of the point's X-coordinate vector in the plane's coordinates; see the XVec property. Optional; default value is (1, 0). |
offset | Double | Signed offset from the plane; see the Offset property. |
Return Value
Type | Description |
---|---|
PointOnPlane | A new PointOnPlane object with 2-dimensional Position, XVec, and Offset properties set to match the given 3-dimensional arguments. |
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | Thrown when the input argument planeReference or position or xvec isor offset is not a valid double value. |