@novorender/api / FollowModule

Class: FollowModule

Defined in: @novorender/src/measure/modules/followPath/module.ts:11

Extends

• BaseModule

Constructors

Constructor

new FollowModule(worker, parent): FollowModule;

Defined in: @novorender/src/measure/modules/base.ts:5

Parameters

Parameter	Type
worker	MeasureWorker
parent	MeasureView

Returns

FollowModule

Inherited from

BaseModule.constructor

Methods

followParametricObjectFromPosition()

followParametricObjectFromPosition(
   id, 
   selectionPosition, 
   setting?): Promise<
  | undefined
| FollowParametricObject>;

Defined in: @novorender/src/measure/modules/followPath/module.ts:93

Returns an object that can be used to calculate camera positions that follow the object Supports Edges, curve segments and cylinder

Parameters

Parameter	Type	Description
id	number	-
selectionPosition	ReadonlyVec3	Function need the selected position to select a subpart of the object in case it is composed of several parts.
setting?	MeasureSettings	Settings.

Returns

Promise< | undefined | FollowParametricObject>

Follow path object that will conain information as well as a function to use for following the parametric object, undefined if the current picked part is not eligble for follow path

---

followParametricObjects()

followParametricObjects(ids, setting?): Promise<
  | undefined
| FollowParametricObject>;

Defined in: @novorender/src/measure/modules/followPath/module.ts:114

Returns an object that can be used to calculate camera posisiotns that follow the objects Supports multiple cylinder, In case of one object, and that object only containing one curve segment it will return curve segment

Parameters

Parameter	Type	Description
ids	number[]	Set of object ids to follow, can be line segments or cylinders.
setting?	MeasureSettings	Settings.

Returns

Promise< | undefined | FollowParametricObject>

Follow path object that will conain information as well as a function to use for following the parametric object, undefined if there are no objects the can be followed in the ids list

---

getCameraValues()

getCameraValues(t, folowObject): Promise<undefined | CameraValues>;

Defined in: @novorender/src/measure/modules/followPath/module.ts:150

Returns camera values for given parameter T, if T is before start it will return camera values at start and if its larger than end it will return camera values for end

Parameters

Parameter	Type
t	number
folowObject	FollowParametricObject

Returns

Promise<undefined | CameraValues>

Properties

parent

readonly parent: MeasureView;

Defined in: @novorender/src/measure/modules/base.ts:7

Inherited from

BaseModule.parent

---

worker

readonly worker: MeasureWorker;

Defined in: @novorender/src/measure/modules/base.ts:6

Inherited from

BaseModule.worker