@novorender/api / ProfileModule
Class: ProfileModule
Defined in: @novorender/src/measure/modules/profile/module.ts:14
Module for converting parametric data to profiles. which can easily be used for charts and graphs
Extends
BaseModule
Constructors
Constructor
new ProfileModule(worker, parent): ProfileModule;
Defined in: @novorender/src/measure/modules/base.ts:5
Parameters
| Parameter | Type |
|---|---|
worker | MeasureWorker |
parent | MeasureView |
Returns
ProfileModule
Inherited from
BaseModule.constructor
Methods
reverse()
reverse(inProfile): Profile;
Defined in: @novorender/src/measure/modules/profile/module.ts:66
Parameters
| Parameter | Type |
|---|---|
inProfile | Profile |
Returns
viewFromEntity()
viewFromEntity(entity, setting?): Promise<undefined | Profile>;
Defined in: @novorender/src/measure/modules/profile/module.ts:23
Returns the profile view of a linestrip where x is the length of the line and y is the height This function can be used if an object contains multiple unconnected entities.
Parameters
| Parameter | Type | Description |
|---|---|---|
entity | MeasureEntity | The parametric entity used to create the profile |
setting? | MeasureSettings | Settings |
Returns
Promise<undefined | Profile>
Profile where x is the length of the line and y is the height, it supports curve segments and cylinders, othwerwise it retuns undefiend
viewFromMultiSelect()
viewFromMultiSelect(products, setting?): Promise<undefined | Profile>;
Defined in: @novorender/src/measure/modules/profile/module.ts:55
Returns the profile view of selected objects where x is the length of the line and y is the height, currently only supports cylinders
Parameters
| Parameter | Type | Description |
|---|---|---|
products | number[] | Products used to create a profile, this can be a list of line segments, line strips or connected cylinders |
setting? | MeasureSettings | Settings |
Returns
Promise<undefined | Profile>
Profile where x is the length of the line and y is the height, it supports curve segments and cylinders, othwerwise it retuns undefiend
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