PinUserObject
Extends
UserObject
Constructor
constructor(options: PinUserObjectOptions): PinUserObject
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| options | PinUserObjectOptions | object | Yes | The PinUserObjectOptions options. Can be an PinUserObjectOptions instance or directly the parameter to pass on the PinUserObjectOptions constructor |
Inherited Properties
id
| Type | Read-Only | Description |
|---|---|---|
| number | symbol | null | YES |
isAdsumObject
Used to check whether this or derived classes are Adsum object 3D. Default is true.
You should not change this, as it used internally by the renderer for optimisation.
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| boolean | YES | True |
isUser
Used to check whether this or derived classes are floors. Default is true.
You should not change this, as it used internally by the renderer for optimisation.
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| boolean | YES | True |
parent
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| SiteObject | FloorObject | YES | - |
placeId
| Type | Read-Only | Description |
|---|---|---|
| number | symbol | null | YES |
Overwritten Methods
Inherited Methods
getDisplayMode
getDisplayMode(): DISPLAY_MODES.NONE|DISPLAY_MODES.VISIBLE|DISPLAY_MODES.TRANSPARENT
Returns:
Type: DISPLAY_MODES.NONE | DISPLAY_MODES.VISIBLE | DISPLAY_MODES.TRANSPARENT
getPosition
getPosition(): { x: number, y: number, z: number }
Gets the position relative to parent.
Returns:
Type: { x: number, y: number, z: number }
getType
getType(): ADSUM_OBJECT_TYPES.UserObject
Returns:
Type: ADSUM_OBJECT_TYPES.UserObject
setDisplayMode
setDisplayMode(displayMode: DISPLAY_MODES.NONE|DISPLAY_MODES.VISIBLE|DISPLAY_MODES.TRANSPARENT): void
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| displayMode | DISPLAY_MODES.NONE | DISPLAY_MODES.VISIBLE | DISPLAY_MODES.TRANSPARENT | Yes | - |
Returns:
Type: void