Plane

Synopsis

The plane design describes an infinite, two-dimensional plane that is oriented with respect to its center point and a normal vector. The local X- and Y-axis of the plane are only constrained to be orthogonal to each other and the normal: vector of the plane, no other direction is guaranteed. The plane is displayed as a small rectangle and a coordinate system and is often used as a reference to orient and position other geometry.

Mixins

InkStrokedMixin

BasePart

Canonicals

Name Type Description
origin point Origin point of the plane.
normal vector Normal vector of the plane.

Parameters

Name Type Description
size number Display length of line representing the plane.
ray part Ray part that describes both the origin point and normal vector of the new plane. The origin of the plane is set to the origin of the ray. The normal of the plane is set to the direction vector of the ray parameter.

Group Rules

<normal> Calculates the localFrame from the normal vector. The normal is used as the localFrame's Z axis, the X axis is a random perpendicular vector to the Z axis, and the Y axis is perpendicular to both the Z and X axes.

<ray> Calculates the origin from the ray's origin rule and the normal from the ray's direction rule.

Example 1

Name: Plane_Ex01
Design: acDrawingDocument
Child Name: myPlane
Child Design: :Plane
Name Type Supplied
normal vector Vector(0.5, 1, 0.1)
origin point Point(0, 0, 0)

Example 2

Name: Plane_Ex02
Design: acDrawingDocument
Name Type Formula
segmentQty integer 5
pointList list

Dim i As Integer = 0

Dim result As List = {}

For i = 1 To segmentQty - 1

result = result + {curve.pointAtLength(i * curve.length / segmentQty)}

Next i

Return result

Child Name: curve
Child Design: :splineCurve
Name Type Supplied
pointList list {Point(0, -1, 0), Point(2, 1, 0), Point(2, 3, 0), Point(5, 0, 0)}
color string "olive green"
Child Name: tangent
Child Design: :Ray
Child List?
Name Type Supplied
direction vector curve.tangent(nth(Child.index, pointList))
origin point nth(Child.index, pointList)
render? boolean False
Quantity integer length(pointList)
Child Name: plane
Child Design: :Plane
Child List?
Name Type Supplied
Ray part nth(Child.index, tangent)
size number 1.0
Quantity integer length(tangent)