class.FollowModule
API > FollowModule
Class: FollowModule
Extends
BaseModule
Constructors
constructor
new FollowModule(
worker
,parent
):FollowModule
Parameters
Parameter | Type |
---|---|
worker | MeasureWorker |
parent | MeasureView |
Returns
Inherited from
BaseModule.constructor
Source
@novorender/measure/modules/base.ts:4
Properties
parent
readonly
parent:MeasureView
Inherited from
BaseModule.parent
Source
@novorender/measure/modules/base.ts:4
worker
readonly
worker:MeasureWorker
Inherited from
BaseModule.worker
Source
@novorender/measure/modules/base.ts:4
Methods
followParametricObjectFromPosition
followParametricObjectFromPosition(
id
,selectionPosition
,setting
?):Promise
\<undefined
|FollowParametricObject
>
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
Source
@novorender/measure/modules/followPath/module.ts:89
followParametricObjects
followParametricObjects(
ids
,setting
?):Promise
\<undefined
|FollowParametricObject
>
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
Source
@novorender/measure/modules/followPath/module.ts:112
getCameraValues
getCameraValues(
t
,folowObject
):Promise
\<undefined
|CameraValues
>
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
>