TBoxComponent

Component for an actor. Only contains updater and cannot be rendered.

Hierarchy

• default
  • TBoxComponent

Index

Constructors

• constructor

Properties

• actor
• canRender
• collider
• dead
• depth
• height
• material
• parentComponent
• shouldRender
• transform
• uuid
• width

Accessors

• angularVelocity
• bodyOptions
• linearVelocity

Methods

• applyCentralForce
• applyCentralImpulse
• applyMaterial
• applyMesh
• applyTransform
• attachTo
• destroy
• getRenderTask
• getWorldTransform
• setAngularDamping
• setAngularVelocity
• setBodyType
• setColor
• setColors
• setFixedRotation
• setFriction
• setIsTrigger
• setLinearDamping
• setLinearVelocity
• setMaterial
• setMesh
• updatePhysicsBody

Constructors

constructor

• new TBoxComponent(engine: default, actor: default, width: number, height: number, depth: number, bodyOptions?: TPhysicsBodyOptions): default

• Overrides default.constructor

  Parameters

  • engine: default

  • actor: default

  • width: number

  • height: number

  • depth: number

  • optionalbodyOptions: TPhysicsBodyOptions

  Returns default

Properties

publicactor

actor: default

Inherited from default.actor

publiccanRender

canRender: boolean = false

Inherited from default.canRender

Indicates whether a component has the ability to be rendered.

publicoptionalcollider

collider?: ICollider

Inherited from default.collider

Collider for this component.

publicdead

dead: boolean = false

Inherited from default.dead

publicdepth

depth: number

publicheight

height: number

publicoptionalmaterial

material?: default

Inherited from default.material

publicoptionalparentComponent

parentComponent?: default

Inherited from default.parentComponent

Parent of this component. If undefined, it is a root component.

publicshouldRender

shouldRender: boolean = false

Inherited from default.shouldRender

Indicates whether a component should be rendered

publictransform

transform: default = ...

Inherited from default.transform

Transform relative to the parent or actor (if has no parent).

publicuuid

uuid: string = ...

Inherited from default.uuid

publicwidth

width: number

Accessors

publicangularVelocity

• get angularVelocity(): undefined | vec3

• Inherited from TMeshComponent.angularVelocity

  Returns undefined | vec3

publicbodyOptions

• get bodyOptions(): TPhysicsBodyOptions

• Inherited from TMeshComponent.bodyOptions

  Get physics body config for scene component

  ---

  Returns TPhysicsBodyOptions

publiclinearVelocity

• get linearVelocity(): undefined | vec3

• Inherited from TMeshComponent.linearVelocity

  Returns undefined | vec3

Methods

publicapplyCentralForce

• applyCentralForce(force: vec3): void

• Inherited from default.applyCentralForce

  Parameters

  • force: vec3

  Returns void

publicapplyCentralImpulse

• applyCentralImpulse(impulse: vec3): void

• Inherited from default.applyCentralImpulse

  Parameters

  • impulse: vec3

  Returns void

publicapplyMaterial

• applyMaterial(engine: default, path: string): Promise<void>

• Inherited from default.applyMaterial

  Parameters

  • engine: default

  • path: string

  Returns Promise<void>

publicapplyMesh

• applyMesh(engine: default, path: string): Promise<void>

• Inherited from default.applyMesh

  Clears the current mesh and starts loading the new mesh

  ---

  Parameters

  • engine: default

  • path: string

  Returns Promise<void>

publicapplyTransform

• applyTransform(): void

• Inherited from default.applyTransform

  Apply transforms ensure transform updates get propagated to the physics world

  ---

  Returns void

publicattachTo

• attachTo(parentComponent: default): void

• Inherited from default.attachTo

  Attaches the component as a child to the given component.

  ---

  Parameters

  • parentComponent: default

  Returns void

publicdestroy

• destroy(): void

• Inherited from default.destroy

  Returns void

publicgetRenderTask

• getRenderTask(): undefined | TSerializedMeshInstance

• Inherited from default.getRenderTask

  Returns undefined | TSerializedMeshInstance

publicgetWorldTransform

• getWorldTransform(): default

• Inherited from default.getWorldTransform

  Gets the component to world transform

  ---

  Returns default

publicsetAngularDamping

• setAngularDamping(damping: number): void

• Inherited from default.setAngularDamping

  Parameters

  • damping: number

  Returns void

publicsetAngularVelocity

• setAngularVelocity(velocity: vec3): void

• Inherited from default.setAngularVelocity

  Parameters

  • velocity: vec3

  Returns void

publicsetBodyType

• setBodyType(type: TPhysicsBodyType): void

• Inherited from default.setBodyType

  Parameters

  • type: TPhysicsBodyType

  Returns void

publicsetColor

• setColor(color: TColor): void

• Parameters

  • color: TColor

  Returns void

publicsetColors

• setColors(palette: { back: TColor; bottom: TColor; front: TColor; left: TColor; right: TColor; top: TColor }): void

• Parameters

  • palette: { back: TColor; bottom: TColor; front: TColor; left: TColor; right: TColor; top: TColor }

  • back: TColor

  • bottom: TColor

  • front: TColor

  • left: TColor

  • right: TColor

  • top: TColor

  Returns void

publicsetFixedRotation

• setFixedRotation(fixedRotation: boolean): void

• Inherited from default.setFixedRotation

  Parameters

  • fixedRotation: boolean

  Returns void

publicsetFriction

• setFriction(friction: number): void

• Inherited from default.setFriction

  Parameters

  • friction: number

  Returns void

publicsetIsTrigger

• setIsTrigger(isTrigger: boolean): void

• Inherited from default.setIsTrigger

  Triggers don't collide with other objects, but they still trigger collision events

  ---

  Parameters

  • isTrigger: boolean

  Returns void

publicsetLinearDamping

• setLinearDamping(damping: number): void

• Inherited from default.setLinearDamping

  Parameters

  • damping: number

  Returns void

publicsetLinearVelocity

• setLinearVelocity(velocity: vec3): void

• Inherited from default.setLinearVelocity

  Parameters

  • velocity: vec3

  Returns void

publicsetMaterial

• setMaterial(material: default): void

• Inherited from default.setMaterial

  Parameters

  • material: default

  Returns void

publicsetMesh

• setMesh(engine: default, positions: number[], normals: number[], indexes: number[], colors: number[], paletteIndex: TPaletteIndex): Promise<void>

• Inherited from default.setMesh

  Parameters

  • engine: default

  • positions: number[]

  • normals: number[]

  • indexes: number[]

  • colors: number[]

  • paletteIndex: TPaletteIndex

  Returns Promise<void>

publicupdatePhysicsBody

• updatePhysicsBody(body: undefined | TPhysicsBody): void

• Inherited from default.updatePhysicsBody

  Set physics body for this component, this is automatically called by the physics world. Changing this will not update the physics world, use the various set methods instead.

  ---

  Parameters

  • body: undefined | TPhysicsBody

  Returns void