telemetry-primitives

Set of simple telemetry primitives for drawing objects in the scene.

!> Note that geometry instances associated with the primitive annotations are shared and should not be modified.

Use

TODO

API

BoxAnnotation

Renders a box with a given size.

extends Mesh

size

size : Vector3 = (1, 1, 1)

The size of the box in X, Y, and Z

center

center : Vector3 = (0, 0, 0)

The center position of the box.

constructor

constructor( material : Material ) : void

EllipticCylinderAnnotation

Renders an elliptical cylinder.

extends Mesh

radiusX

radiusX : Number = 1

The radius of the cylinder in the X dimension.

radiusY

radiusY : Number = 1

The radius of the cylinder in the Y dimension.

length

length : Number = 1

The length of the cylinder in the Z dimension.

center

center : Vector3 = (0, 0, 0)

The center of the cylinder.

constructor

constructor( material : Material ) : void

CylinderAnnotation

Version of EllipticCylinderAnnotation that has a setter for the full cylinder radius.

extends EllipticCylinderAnnotation

radius

radius : Number = 1

Sets the radius in X and Y of the cylinder.

CAHVOREOptions

width

width : Number

max number of pixels in width

height

height : Number

max number of pixels in height

C

C : Vector3

input model center

A

A : Vector3

input model axis

H

H : Vector3

input model horiz

V

V : Vector3

input model vert

O

O : Vector3 | null = null

input model optical axis, only required for CAHVORE

R

R : Vector3 | null = null

radial-distortion, only required for CAHVORE

E

E : Vector3 | null = null

entrance-pupil, only required for CAHVORE

linearity

linearity : Number = 1

linearity parameter, only required for CAHVORE

nearDist

nearDist : Number = 0.085

the distance between the camera model and the near plane

farDist

farDist : Number = 10.0

the distance between the camera model and the far plane

widthSegments

widthSegments : Number = 16

lthe number of segments to create along the x axis (all sides)

heightSegments

heightSegments : Number = 16

lthe number of segments to create along the x axis (all sides)

FrustumAnnotation

Frustum for depicting the view volume of a camera. This will be transformed using CAHV or CAHVORE settings.

extends Mesh

constructor

constructor( material : Material ) : void

setParameters

setParameters( parameters : CAHVOREOptions ) : void

Update the parameters of the CAHVORE frustum geometry.

LinearFrustumAnnotation

Create a linear camera frustum facing the -Z axis with X to the right and Y up.

extends Mesh

setFromProjectionMatrix

setFromProjectionMatrix(
	projectionMatrix : Matrix4, 
	frame : Matrix4, 
	near : Number, 
	far : Number
) : void

Updates the linear frustum view based on the provided projection matrix, frame, near, and far values.

HexagonAnnotation

Class for creating and rendering a hexagonal prism.

extends Mesh

length

length : Number = 1

Sets the length of the prism along the Z axis.

constructor

constructor( material : Material ) : void

setVertices

setVertices( points : ...Vector2 | Vector3 ) : void

Set the position of the hexagon vertices on X and Y.

getVertices

getVertices( points : ...Vector2 | Vector3 ) : void

Get the position of the hexagon vertices on X and Y. If Vector3s are passed in Z is set to 0.

SpheroidAnnotation

Class for rendering a sphere with asymmetrical radii on X, Y, and Z.

extends Mesh

dimensions

dimensions : Vector3 = (1, 1, 1)

The dimensions of the radius on each X, Y, and Z dimenions of the spheroid.

center

center : Vector3 = (0, 0, 0)

The center position of the spheroid.

constructor

constructor( material : Material ) : void

SphereAnnotation

Version of SpheroidAnnotation that has a setter for the full sphere radius.

extends SpheroidAnnotation

radius

radius : Number = 1

Sets the radius for the full sphere. Returns the radius for X if the radius dimensions have been been set separately.

TriangleAnnotation

Class for rendering triangular prisms.

extends Mesh

length

length : Number = 1

The length of the triagular prism on the Z axis.

constructor

constructor( material : Material ) : void

setVertices

setVertices( p1 : Vector2 | Vector3, p2 : Vector2 | Vector3, p3 : Vector2 | Vector3 ) : void

Sets the X and Y positions of triangl vertices.

getVertices

getVertices( p1 : Vector2 | Vector3, p2 : Vector2 | Vector3, p3 : Vector2 | Vector3 ) : void

Sets p1, p2, and p3 to the X and Y position of the triangle vertices. Z is set to 0 if Vector3s are passed in.

StadiumAnnotation

Renders a box with a given size.

extends Mesh

length

length : Number = 1

The length of the shape in the Z dimension.

constructor

constructor( material : Material ) : void

setParameters

setParameters( p0 : Vector2, p1 : Vector2, radius : Number ) : void

Sets the center line and radius of the stadium shape.

LineAnnotation

Creates a thick line.

extends Line2

color

color : Color = 0xffffff

Sets the color of the line.

lineWidth

lineWidth : Number = 1

Sets the width of the line.

constructor

constructor( material : LineMaterial ) : void

setPositions

setPositions( arr : Array | TypedArray ) : void

Sets the geometry of the line to the passed array of vertices. The array should be a list of numbers with every 3 tuple representing a point in space.

setFromGeometry

setFromGeometry( newGeometry : BufferGeometry, threshold : Number = 45 ) : void

Sets the line based on the edges of the given geometry. The threshold is angle between the faces over which a line will be added in degrees.

EllipseLineAnnotation

Class for rendering an ellipse with a Line.

extends LineAnnotation

radiusX

radiusX : Number = 1

Sets the radius of the ellipse on the X axis.

radiusY

radiusY : Number = 1

Sets the radius of the ellipse on the Y axis.

constructor

constructor( material : LineMaterial ) : void

CircleLineAnnotation

Class for rendering a cricle with a Line.

extends EllipseLineAnnotation

radius

radius : Number

Sets the X and Y radius to the same value. Returns the x radius if they were set separately.

SquareLineAnnotation

Renders a square line on X and Y.

extends LineAnnotation

constructor

constructor( material : LineMaterial ) : void

setSize

setSize( width : Number, height : Number ) : void

Sets the width and height of the square on X and Y.

TriangleLineAnnotation

Class for rendering a triangular line.

extends LineAnnotation

constructor

constructor( material : LineMaterial ) : void

setVertices

setVertices( v1 : Vector2 | Vector3, v2 : Vector2 | Vector3, v3 : Vector2 | Vector3 ) : void

Sets the positions of the vertices on X and Y.

getVertices

getVertices( v1 : Vector2 | Vector3, v2 : Vector2 | Vector3, v3 : Vector2 | Vector3 ) : void

Gets the positions of the vertices on X and Y. If Vector3s are passed in Z is set to 0.

StadiumLineAnnotation

Renders a stadium shape.

extends LineAnnotation

constructor

constructor( material : LineMaterial ) : void

setParameters

setParameters( p0 : Vector2, p1 : Vector2, radius : Number ) : void

Sets the center line and radius of the stadium shape.

StencilShape

Class for stenciling a shape intersection into the stencil buffer. Needs to be rendered after some geometry has already been rendered into the depth buffer. Raycasting is disabled on the stencil geometry.

extends Group

shape

shape : Mesh

Getter for the shape that is being rendered.

constructor

constructor( shape : Mesh ) : void

Constructor that take the shape to render.

setRenderOrder

setRenderOrder( renderOrder : Number ) : void

Sets the render order of the stencil.

StampShape

Renders a color where the given shape intersects any data in the depth buffer.

extends StencilShape

stamp

stamp : Mesh

Getter for the mesh with material that will be rendered.

constructor

constructor( shape : Mesh ) : void

Takes a shape with a material to be rendered at the shape overlap. The object itself is stored as a reference in this StampShape instance and the material on the shape has the necessary stencil and depth properties set on it. Raycasting is disabled on the stencil stamp geometry.

LabeledVertex

Spherical vertex rendered with a label above it.

extends SphereAnnotation

text

text : String = ''

The text in the label.

args

args : ...null

WedgePlane

Class for rendering a wedge on plane using a shader. Angle starts at the X axis.

extends Mesh

angle

angle : Number = 0

The angle of the wedge in radians.

opacity

opacity : Number = 1

The opacity of the wedge.

color

color : Color = 0xffffff

The Color of the wedge.

radius

radius : Number = 1

The radius of the wedge.