Class Visual

Hierarchy

Component
- Visual

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Visual(props?: ObjectProps<Visual>): Visual

- Defined in src/graphics/Visual.ts:129
Parameters
- Optional props: ObjectProps<Visual>
Returns Visual

Accessors

active

get active(): boolean
set active(active: boolean): void

Inherited from Component.active
- Defined in src/core/Component.ts:12
Returns boolean
Inherited from Component.active
- Defined in src/core/Component.ts:13
Parameters
- active: boolean
Returns void

animatedMaterial

get animatedMaterial(): undefined | Material
set animatedMaterial(animatedMaterial: Material | undefined): void

- Defined in src/graphics/Visual.ts:55
Returns undefined | Material
- Defined in src/graphics/Visual.ts:56
Parameters
- animatedMaterial: Material | undefined
Returns void

bucketId

get bucketId(): string

- Defined in src/graphics/Visual.ts:67
Returns string

castShadows

get castShadows(): boolean
set castShadows(cast: boolean): void

- Defined in src/graphics/Visual.ts:26
Returns boolean
- Defined in src/graphics/Visual.ts:27
Parameters
- cast: boolean
Returns void

entity

get entity(): Entity

Inherited from Component.entity
- Defined in src/core/Component.ts:10
Returns Entity

envMap

get envMap(): null | Texture
set envMap(envMap: Texture | null): void

- Defined in src/graphics/Visual.ts:60
Returns null | Texture
- Defined in src/graphics/Visual.ts:61
Parameters
- envMap: Texture | null
Returns void

geometry

get geometry(): undefined | Geometry
set geometry(geometry: Geometry | undefined): void

- Defined in src/graphics/Visual.ts:23
Returns undefined | Geometry
- Defined in src/graphics/Visual.ts:39
Parameters
- geometry: Geometry | undefined
Returns void

group

get group(): null | VisualGroup
set group(group: VisualGroup | null): void

- Defined in src/graphics/Visual.ts:24
Returns null | VisualGroup
- Defined in src/graphics/Visual.ts:49
Parameters
- group: VisualGroup | null
Returns void

hasNormalMap

get hasNormalMap(): boolean

- Defined in src/graphics/Visual.ts:107
Returns boolean

hasVertexColor

get hasVertexColor(): boolean

- Defined in src/graphics/Visual.ts:112
Returns boolean

id

get id(): string

Inherited from Component.id
- Defined in src/core/Component.ts:11
Returns string

isReflective

get isReflective(): boolean

- Defined in src/graphics/Visual.ts:102
Returns boolean

isSkinned

get isSkinned(): boolean

- Defined in src/graphics/Visual.ts:98
Returns boolean

material

get material(): null | Material
set material(material: Material | null): void

- Defined in src/graphics/Visual.ts:22
Returns null | Material
- Defined in src/graphics/Visual.ts:48
Parameters
- material: Material | null
Returns void

parent

get parent(): undefined | Entity

Inherited from Component.parent
- Defined in src/core/Component.ts:9
Returns undefined | Entity

receiveFog

get receiveFog(): boolean
set receiveFog(receive: boolean): void

- Defined in src/graphics/Visual.ts:34
Returns boolean
- Defined in src/graphics/Visual.ts:35
Parameters
- receive: boolean
Returns void

receiveShadows

get receiveShadows(): boolean
set receiveShadows(receive: boolean): void

- Defined in src/graphics/Visual.ts:29
Returns boolean
- Defined in src/graphics/Visual.ts:30
Parameters
- receive: boolean
Returns void

version

get version(): number

- Defined in src/graphics/Visual.ts:20
Returns number

vertexBuffer

get vertexBuffer(): null | VertexBuffer

- Defined in src/graphics/Visual.ts:51
Returns null | VertexBuffer

worldTransform

get worldTransform(): Matrix44

- Defined in src/graphics/Visual.ts:63
Returns Matrix44

Methods

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Overrides SerializableObject.destroy
- Defined in src/graphics/Visual.ts:148
Returns void

graphicUpdate

graphicUpdate(camera: Camera): Changed | Unchanged | Unchanged

- Defined in src/graphics/Visual.ts:143
Parameters
- camera: Camera
Returns Changed | Unchanged | Unchanged

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Inherited from Component.isLoaded
- Defined in src/core/Component.ts:36
Returns boolean

onReplace

onReplace(previous: Component): void

Inherited from Component.onReplace
- Defined in src/core/Component.ts:46
Parameters
- previous: Component
Returns void

reset

reset(): void

Inherited from Component.reset
- Defined in src/core/Component.ts:40
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setEntity

setEntity(entity: Entity): void

Overrides Component.setEntity
- Defined in src/graphics/Visual.ts:138
Parameters
- entity: Entity
Returns void

setProperty

setProperty(name: string, value: any): void

Inherited from SerializableObject.setProperty
- Defined in src/core/SerializableObject.ts:37
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/graphics/Visual.ts:156
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject