Class PointsMaterial

Configures the size and shape of ViewObjects that represent clouds of points.

Located at View.pointsMaterial.
Supports round and square points.
Optional perspective point scaling.

Hierarchy (View Summary)

Component
- PointsMaterial

Index

Properties

Properties

destroyed

destroyed: boolean

True once this Component has been destroyed.

Don't use this Component if this is true.

`Protected`dirty

dirty: boolean

id

id: string

Unique ID of this Component.

`Readonly`view

view: View

The View to which this PointsMaterial belongs.

Accessors

filterIntensity

get filterIntensity(): boolean
Gets whether points are made invisible when their intensity lies outside PointsMaterial.minIntensity and PointsMaterial.maxIntensity.

Default is false.

Returns boolean
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:193
set filterIntensity(value: boolean): void
Sets whether points are made invisible when their intensity lies outside PointsMaterial.minIntensity and PointsMaterial.maxIntensity.

Default is false.
Parameters
- value: boolean
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:179

maxIntensity

get maxIntensity(): number
Gets the maximum intensity of rendered points when PointsMaterial.filterIntensity is true.

Default value is 1.

Returns number
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:237
set maxIntensity(value: number): void
Sets the maximum intensity of rendered points when PointsMaterial.filterIntensity is true.

Default value is 1.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:224

maxPerspectivePointSize

get maxPerspectivePointSize(): number
Gets the maximum rendered size of points when PointsMaterial.perspectivePoints is true.

Default value is 6 pixels.

Returns number
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:169
set maxPerspectivePointSize(value: number): void
Sets the maximum rendered size of points when PointsMaterial.perspectivePoints is true.

Default value is 6 pixels.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:156

minIntensity

get minIntensity(): number
Gets the minimum intensity of rendered points when PointsMaterial.filterIntensity is true.

Default value is 0.

Returns number
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:215
set minIntensity(value: number): void
Sets the minimum intensity of rendered points when PointsMaterial.filterIntensity is true.

Default value is 0.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:202

minPerspectivePointSize

get minPerspectivePointSize(): number
Gets the minimum rendered size of points when PointsMaterial.perspectivePoints is true.

Default value is 1.0 pixels.

Returns number
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:147
set minPerspectivePointSize(value: number): void
Sets the minimum rendered size of points when PointsMaterial.perspectivePoints is true.

Default value is 1.0 pixels.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:132

perspectivePoints

get perspectivePoints(): boolean
Gets if rendered point size reduces with distance when Camera.projection is set to PerspectiveProjectionType.

Default is false.

Returns boolean
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:123
set perspectivePoints(value: boolean): void
Sets if rendered point size reduces with distance when Camera.projection is set to PerspectiveProjectionType.

Default is true.
Parameters
- value: boolean
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:110

pointSize

get pointSize(): number
Gets point size.

Default value is 2.0 pixels.

Returns number
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:78
set pointSize(value: number): void
Sets point size.

Default value is 2.0 pixels.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:68

roundPoints

get roundPoints(): boolean
Gets if points are round or square.

Default is true to set points round.

Returns boolean
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:101
set roundPoints(value: boolean): void
Sets if points are round or square.

Default is true to set points round.
Parameters
- value: boolean
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:88

Methods

`Protected`clean

clean(): void
Forces this component to action any deferred state updates.

Returns void
Inherited from Component.clean
- Defined in packages/sdk/src/core/Component.ts:119

`Protected`cleanIfDirty

cleanIfDirty(): void
Gives this component an opportunity to action any defered state updates.

Returns void
Inherited from Component.cleanIfDirty
- Defined in packages/sdk/src/core/Component.ts:109

`Protected`error

error(message: string): void
Protected
Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>
Parameters
- message: string
  The error message to log
Returns void
Inherited from Component.error
- Defined in packages/sdk/src/core/Component.ts:95

fromParams

fromParams(pointsMaterialParams: PointsMaterialParams): void
Configures this PointsMaterial.
Parameters
- pointsMaterialParams: PointsMaterialParams
Returns void
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:259

`Protected`log

log(message: string): void
Protected
Logs a message for this component.

The message will have this format: [LOG] [<component type> <component id>: <message>
Parameters
- message: string
  The message to log
Returns void
Inherited from Component.log
- Defined in packages/sdk/src/core/Component.ts:71

`Protected`setDirty

setDirty(): void
Flags this component as having a defered state updates it needs to perform.

Returns void
Inherited from Component.setDirty
- Defined in packages/sdk/src/core/Component.ts:102

toParams

toParams(): PointsMaterialParams
Gets the current configuration of this PointsMaterial.

Returns PointsMaterialParams
- Defined in packages/sdk/src/viewer/PointsMaterial.ts:283

`Protected`warn

warn(message: string): void
Protected
Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>
Parameters
- message: string
  The warning message to log
Returns void
Inherited from Component.warn
- Defined in packages/sdk/src/core/Component.ts:83

Events

onDestroyed

onDestroyed: EventEmitter<Component, null>

Emits an event when the Component has been destroyed.

Class PointsMaterial

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Events

Properties

destroyed

Protecteddirty

id

Readonlyview

Accessors

filterIntensity

Returns boolean

Parameters

Returns void

maxIntensity

Returns number

Parameters

Returns void

maxPerspectivePointSize

Returns number

Parameters

Returns void

minIntensity

Returns number

Parameters

Returns void

minPerspectivePointSize

Returns number

Parameters

Returns void

perspectivePoints

Returns boolean

Parameters

Returns void

pointSize

Returns number

Parameters

Returns void

roundPoints

Returns boolean

Parameters

Returns void

Methods

Protectedclean

Returns void

ProtectedcleanIfDirty

Returns void

Protectederror

Parameters

Returns void

fromParams

Parameters

Returns void

Protectedlog

Parameters

Returns void

ProtectedsetDirty

Returns void

toParams

Returns PointsMaterialParams

Protectedwarn

Parameters

Returns void

Events

onDestroyed

Settings

On This Page

`Protected`dirty

`Readonly`view

`Protected`clean

`Protected`cleanIfDirty

`Protected`error

`Protected`log

`Protected`setDirty

`Protected`warn