Class SurfaceOptions

Configuration for surface rendering options.

Hierarchy (View Summary)

EntityStructure
- SurfaceOptions

Index

Constructors

Properties

enhanceWithNativeAR id meta type

Methods

getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

Constructors

`Protected`constructor

new SurfaceOptions(): SurfaceOptions
Snap Hidden
Returns SurfaceOptions
Overrides EntityStructure.constructor

Properties

enhanceWithNativeAR

enhanceWithNativeAR: boolean

Enable native AR enhancement for the surface.

`Readonly`id

id: Uuid

The unique id of the entity.

`Readonly`meta

meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

`Readonly`type

type: string

The entity's type.

Methods

getDirectlyReferencedEntities

getDirectlyReferencedEntities(): Entity[]
A list of entities which this entity has a reference to.

Returns Entity[]
Inherited from EntityStructure.getDirectlyReferencedEntities

`Static`getMeta

getMeta(): Meta
Returns Meta
Overrides EntityStructure.getMeta

getOwnedEntities

getOwnedEntities(): Entity[]
A list of entities which has a reference to this entity.

Returns Entity[]
Inherited from EntityStructure.getOwnedEntities

`Static`getTypeName

getTypeName(): string
Returns string
Overrides EntityStructure.getTypeName

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from EntityStructure.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from EntityStructure.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from EntityStructure.isSame