AnimatedSprite | Divine Engine API

Hierarchy

Sprite
- AnimatedSprite

Implements

IMessageHandler

Constructors

constructor

new AnimatedSprite(name: string, materialName: string, width?: number, height?: number, frameWidth?: number, frameHeight?: number, frameCount?: number, frameSequence?: number[]): AnimatedSprite

Overrides Sprite.constructor
- Defined in rendersystem/animatedsprite.ts:64
Class constructor.

Parameters
- name: string
- materialName: string
- width: number = 100
- height: number = 100
- frameWidth: number = 10
- frameHeight: number = 10
- frameCount: number = 1
- frameSequence: number[] = ...
Returns AnimatedSprite

Properties

Private _assetHeight

_assetHeight: number = 2

Private _assetLoaded

_assetLoaded: boolean = false

Private _assetWidth

_assetWidth: number = 2

Protected _buffer

_buffer: undefined | GLBuffer

Private _currentFrame

_currentFrame: number = 0

Private _currentTime

_currentTime: number = 0

Private _frameCount

_frameCount: number

Private _frameHeight

_frameHeight: number

Private _frameSequence

_frameSequence: number[]

Private _frameTime

_frameTime: number = 10

Private _frameUV

_frameUV: UVInfo[] = ...

Private _frameWidth

_frameWidth: number

Protected _height

_height: number

Private _isPlaying

_isPlaying: boolean = true

Protected _material

_material: undefined | Material

Protected _materialName

_materialName: undefined | string

Protected _name

_name: string

Protected _origin

_origin: Vector3 = ...

Protected _vertices

_vertices: Vertex[] = ...

Protected _width

_width: number

Accessors

currentFrame

get currentFrame(): number

- Defined in rendersystem/animatedsprite.ts:29
Gets the current frame

Returns number
number

frameCount

get frameCount(): number

- Defined in rendersystem/animatedsprite.ts:36
Gets the current frame count.

Returns number
number

height

get height(): number

Inherited from Sprite.height
- Defined in rendersystem/sprite.ts:47
Gets the height of the sprite.

Returns number
number

isPlaying

get isPlaying(): boolean

- Defined in rendersystem/animatedsprite.ts:43
Gets if the sprite is playing or not.

Returns boolean
boolean

materialName

get materialName(): string

- Defined in rendersystem/animatedsprite.ts:50
Gets the material name.

Returns string
string

name

get name(): string

Inherited from Sprite.name
- Defined in rendersystem/sprite.ts:25
Gets the name of the sprite.

Returns string
string

origin

get origin(): Vector3
set origin(value: Vector3): void

Inherited from Sprite.origin
- Defined in rendersystem/sprite.ts:32
Gets the origin of the sprite.

Returns Vector3
Vector3
Inherited from Sprite.origin
- Defined in rendersystem/sprite.ts:39
Sets the origin of the sprite.

Parameters
- value: Vector3
Returns void
Vector3

width

get width(): number

Inherited from Sprite.width
- Defined in rendersystem/sprite.ts:54
Gets the width of the sprite.

Returns number
number

Methods

Private calculateUV

calculateUV(): void

- Defined in rendersystem/animatedsprite.ts:194
Calculates the (u,v) textuer coordinates.

Returns void
void

Protected calculateVertices

calculateVertices(): void

Inherited from Sprite.calculateVertices
- Defined in rendersystem/sprite.ts:135
Calculates the sprites verticies.

Returns void
void

destroy

destroy(): void

Overrides Sprite.destroy
- Defined in rendersystem/animatedsprite.ts:77
Destroys the animated sprite.

Returns void
void

draw

draw(shader: Shader, model: Matrix4): void

Inherited from Sprite.draw
- Defined in rendersystem/sprite.ts:87
Draws the sprite.

Parameters
- shader: Shader
- model: Matrix4
Returns void
void

load

load(): void

Overrides Sprite.load
- Defined in rendersystem/animatedsprite.ts:84
Loads the animated sprite.

Returns void
void

onMessage

onMessage(message: Message): void

Implementation of IMessageHandler.onMessage
- Defined in rendersystem/animatedsprite.ts:95
Handles messages sent to the animated sprite.

Parameters
- message: Message
Returns void
void

play

play(): void

- Defined in rendersystem/animatedsprite.ts:108
Plays the animated sprite component.

Returns void
void

Protected recalculateVertices

recalculateVertices(): void

Inherited from Sprite.recalculateVertices
- Defined in rendersystem/sprite.ts:154
Recalculates the sprites verticies fully.

Returns void
void

setFrame

setFrame(frameNumber: number): void

- Defined in rendersystem/animatedsprite.ts:116
Sets the frame number to play the animation at.

Parameters
- frameNumber: number
Returns void
void

setFrameOnce

setFrameOnce(frameNumber: number): void

- Defined in rendersystem/animatedsprite.ts:128
Sets the frame number to play the animation at one time.

Parameters
- frameNumber: number
Returns void
void

Private setupFromMaterial

setupFromMaterial(): void

- Defined in rendersystem/animatedsprite.ts:216
Sets up the material from loaded assets.

Returns void
void

stop

stop(): void

- Defined in rendersystem/animatedsprite.ts:143
Stops running the sprite.

Returns void
void

update

update(delta: number): void

Overrides Sprite.update
- Defined in rendersystem/animatedsprite.ts:151
Updates the animated sprite.

Parameters
- delta: number
Returns void
void

updateVerticies

updateVerticies(): void

- Defined in rendersystem/animatedsprite.ts:176
Updates the sprite's vertex coordinates.

Returns void
void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

materialName: string

width: number = 100

height: number = 100

frameWidth: number = 10

frameHeight: number = 10

frameCount: number = 1

frameSequence: number[] = ...

Returns AnimatedSprite

Properties

Private _assetHeight

Private _assetLoaded

Private _assetWidth

Protected _buffer

Private _currentFrame

Private _currentTime

Private _frameCount

Private _frameHeight

Private _frameSequence

Private _frameTime

Private _frameUV

Private _frameWidth

Protected _height

Private _isPlaying

Protected _material

Protected _materialName

Protected _name

Protected _origin

Protected _vertices

Protected _width

Accessors

currentFrame

Returns number

frameCount

Returns number

height

Returns number

isPlaying

Returns boolean

materialName

Returns string

name

Returns string

origin

Returns Vector3

Parameters

value: Vector3

Returns void

width

Returns number

Methods

Private calculateUV

Returns void

Protected calculateVertices

Returns void

destroy

Returns void

draw

Parameters

shader: Shader

model: Matrix4

Returns void

load

Returns void

onMessage

Parameters

message: Message

Returns void

play

Returns void