Class: DefPlane

algeobra3d~DefPlane(params, infiniteopt)

Definition of a plane in 3D space

Constructor

new DefPlane(params, infiniteopt)

Default values
Parameters:
Name Type Attributes Description
params Object
Properties
Name Type Attributes Description
origin THREE.Vector3 <optional>
 The origin point of the plane
u THREE.Vector3 <optional>
 The first spanning vector
v THREE.Vector3 <optional>
 The second spanning vector
infinite Boolean <optional>
 Whether or not the plane is infinite or is bound by its spanning vectors
Source:

Methods

compute(info) → {Object}

Computes the plane
Parameters:
Name Type Description
info CreateInfo The creation info
Source:
Returns:
A plane of type TYPE_PLANE
Type
Object

(static) fromPlane(plane, paramsopt) → {CreateInfo}

Computes a new plane from another given plane
Parameters:
Name Type Attributes Description
plane Number | Object Either the index or value of a TYPE_PLANE. The reference plane
params Object <optional>
Properties
Name Type Attributes Description
ref Number | Object <optional>
 Either the index or value of a TYPE_POINT3. A point to which to attach the new plane
minU Number | Object <optional>
 Either the index or value of a TYPE_NUMBER. Minimum parameter for the first spanning vector
maxU Number | Object <optional>
 Either the index or value of a TYPE_NUMBER. Maximum parameter for the first spanning vector
minV Number | Object <optional>
 Either the index or value of a TYPE_NUMBER. Minimum parameter for the second spanning vector
maxV Number | Object <optional>
 Either the index or value of a TYPE_NUMBER. Maximum parameter for the second spanning vector
infinite Number | Object <optional>
 Either the index or value of a TYPE_BOOLEAN. Whether the plane is infinite
Source:
Returns:
The creation info
Type
CreateInfo

(static) fromPoints(p0, p1, p2, paramsopt) → {CreateInfo}

Computes the plane for the given values
Parameters:
Name Type Attributes Description
p0 Number | Object Either the index or value of a TYPE_POINT3. The first point
p1 Number | Object Either the index or value of a TYPE_POINT3. The second point
p2 Number | Object Either the index or value of a TYPE_POINT3. The third point
params Object <optional>
Properties
Name Type Attributes Description
infinite Number | Object <optional>
 Either the index or value of a TYPE_BOOLEAN. Whether the plane is infinite
makeOrthogonal Boolean <optional>
 If true, the computed spanning vectors will be made orthogonal
Source:
Returns:
The creation info
Type
CreateInfo

(static) fromValues(params, normalizeAxesopt) → {CreateInfo}

Computes the plane for the given values If any value is EMPTY, the default values are used
Parameters:
Name Type Attributes Description
params Object
Properties
Name Type Attributes Description
origin Number | Object <optional>
 Either the index or value of a TYPE_POINT3. The origin
u Number | Object <optional>
 Either the index or value of a TYPE_VECTOR3. The first spanning vector
v Number | Object <optional>
 Either the index or value of a TYPE_VECTOR3. The second spanning vector
origin Number | Object <optional>
 Either the index or value of a TYPE_BOOLEAN. Whether or not the plane is infinite
normalizeAxes Boolean <optional>
 If true, the given spanning vectors will be normalized
Source:
Returns:
The creation info
Type
CreateInfo