M

Application.NewPointOnPlane

Description:
Construct a PointOnPlane object which is used to define the placement of a ReferencePoint from its property values.

public PointOnPlane NewPointOnPlane(
	Reference planeReference,
	UV position,
	UV xvec,
	double offset
)

Public Function NewPointOnPlane ( 
	planeReference As Reference,
	position As UV,
	xvec As UV,
	offset As Double
) As PointOnPlane

public:
PointOnPlane^ NewPointOnPlane(
	Reference^ planeReference, 
	UV^ position, 
	UV^ xvec, 
	double offset
)

member NewPointOnPlane : 
        planeReference : Reference * 
        position : UV * 
        xvec : UV * 
        offset : float -> PointOnPlane

Reference

planeReference

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.)
UV

position

Coordinates of the point's projection onto the plane; see the Position property.
UV

xvec

The direction of the point's X-coordinate vector in the plane's coordinates; see the XVec property. Optional; default value is (1, 0).
Double

offset

Signed offset from the plane; see the Offset property.

Return Value PointOnPlane A new PointOnPlane object with 2-dimensional Position, XVec, and Offset properties set to match the given 3-dimensional arguments.

ArgumentNullException

Thrown when the input argument planeReference or position or xvec isor offset is not a valid double value.