Class CustomShadedFrameElement

A single Sprite (not animated) rendered using a custom material

Hierarchy

DirectRenderElement
- CustomShadedFrameElement

Index

Constructors

constructor

new CustomShadedFrameElement(): CustomShadedFrameElement
Returns CustomShadedFrameElement
Inherited from DirectRenderElement.constructor
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:66

Properties

_children

_children: RenderElement[]

`Private` _dirty

_dirty: boolean = true

`Private` _frame

_frame: SpriteSheetFrame = null

color1

color1: Color = ...

TOP-LEFT

color2

color2: Color = ...

BOTTOM-LEFT

color3

color3: Color = ...

TOP-RIGHT

color4

color4: Color = ...

BOTTOM-RIGHT

material

material: FatMaterial = null

name

name: string = ""

regX

regX: number = 0

regY

regY: number = 0

`Private` tex1

tex1: Vector2 = ...

`Private` tex2

tex2: Vector2 = ...

`Private` tex3

tex3: Vector2 = ...

`Private` tex4

tex4: Vector2 = ...

visible

visible: boolean = true

Accessors

blendMode

get blendMode(): BlendMode
Returns BlendMode
Inherited from DirectRenderElement.blendMode
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:118
set blendMode(value: BlendMode): void
Parameters
- value: BlendMode
Returns void
Inherited from DirectRenderElement.blendMode
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:114

frame

get frame(): SpriteSheetFrame
Returns SpriteSheetFrame
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:989
set frame(v: SpriteSheetFrame): void
Parameters
- v: SpriteSheetFrame
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:993

height

get height(): number
Returns number
Inherited from DirectRenderElement.height
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:69
set height(v: number): void
Parameters
- v: number
Returns void
Inherited from DirectRenderElement.height
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:157

matrix

get matrix(): AffineMatrix
Returns a matrix representing x,y,rotation, scale.

It is also possible to have a manual matrix which ignores those values.

Returns AffineMatrix
Inherited from DirectRenderElement.matrix
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:182
set matrix(v: AffineMatrix): void
Setting a matrix will disable the usage of: x, y, scaleX, etc. and instead the given matrix will be used.

To get back to the usage of the standard behavior use useStandardMatrix().
Parameters
- v: AffineMatrix
Returns void
Inherited from DirectRenderElement.matrix
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:206

numChildren

get numChildren(): number
Returns number
Inherited from DirectRenderElement.numChildren
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:279

parent

get parent(): RenderElement
Returns RenderElement
Inherited from DirectRenderElement.parent
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:220

rotation

get rotation(): number
Returns number
Inherited from DirectRenderElement.rotation
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:81
set rotation(v: number): void
Parameters
- v: number
Returns void
Inherited from DirectRenderElement.rotation
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:130

scale

get scale(): number
Returns number
Inherited from DirectRenderElement.scale
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:150
set scale(v: number): void
Parameters
- v: number
Returns void
Inherited from DirectRenderElement.scale
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:143

scaleX

get scaleX(): number
Returns number
Inherited from DirectRenderElement.scaleX
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:84
set scaleX(v: number): void
Parameters
- v: number
Returns void
Inherited from DirectRenderElement.scaleX
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:134

scaleY

get scaleY(): number
Returns number
Inherited from DirectRenderElement.scaleY
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:87
set scaleY(v: number): void
Parameters
- v: number
Returns void
Inherited from DirectRenderElement.scaleY
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:138

width

get width(): number
Returns number
Inherited from DirectRenderElement.width
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:72
set width(v: number): void
Parameters
- v: number
Returns void
Inherited from DirectRenderElement.width
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:154

worldMatrix

get worldMatrix(): AffineMatrix
Creates a full world matrix meaning all parent matrices.

This is not cached. Use with care.

Returns AffineMatrix
Inherited from DirectRenderElement.worldMatrix
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:166

x

get x(): number
Returns number
Inherited from DirectRenderElement.x
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:75
set x(v: number): void
Parameters
- v: number
Returns void
Inherited from DirectRenderElement.x
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:122

y

get y(): number
Returns number
Inherited from DirectRenderElement.y
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:78
set y(v: number): void
Parameters
- v: number
Returns void
Inherited from DirectRenderElement.y
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:126

Methods

addChild

addChild(child: RenderElement): void
Parameters
- child: RenderElement
Returns void
Inherited from DirectRenderElement.addChild
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:237

detachChild

detachChild(child: RenderElement): void
Parameters
- child: RenderElement
Returns void
Inherited from DirectRenderElement.detachChild
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:224

getChildAt

getChildAt(index: number): RenderElement
Parameters
- index: number
Returns RenderElement
Inherited from DirectRenderElement.getChildAt
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:253

`Private` prepare

prepare(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:998

removeAllChildren

removeAllChildren(): void
Returns void
Inherited from DirectRenderElement.removeAllChildren
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:273

removeChild

removeChild(elem: RenderElement): false | RenderElement
Parameters
- elem: RenderElement
Returns false | RenderElement
Inherited from DirectRenderElement.removeChild
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:264

removeChildAt

removeChildAt(index: number): RenderElement
Parameters
- index: number
Returns RenderElement
Inherited from DirectRenderElement.removeChildAt
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:257

renderDirect

renderDirect(renderer: FatRenderer, parentMatrix: AffineMatrix): void
Overwrite here.

Note:
- fatRenderer::rootMatrix is already set to parentMatrix
- rootMatrix can be left modified (no need for caching)
- only directXXX calls may be used
- do NOT modify or Cache render here. This will break rendering
Parameters
- renderer: FatRenderer
- parentMatrix: AffineMatrix
Returns void
Overrides DirectRenderElement.renderDirect
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:1022

setHorizontalFade

setHorizontalFade(r1: number, g1: number, b1: number, a1: number, r2: number, g2: number, b2: number, a2: number): void
<-------------> ^ ^ | (r2,g2,b2,a2) (r1,g1,b1,a1)
Parameters
- r1: number
- g1: number
- b1: number
- a1: number
- r2: number
- g2: number
- b2: number
- a2: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:1079

setSolidColor

setSolidColor(r: number, g: number, b: number, a: number): void
Parameters
- r: number
- g: number
- b: number
- a: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:1049

setVerticalFade

setVerticalFade(r1: number, g1: number, b1: number, a1: number, r2: number, g2: number, b2: number, a2: number): void
^ <-- (r1,g1,b1,a1) | | | | | v <-- (r2,g2,b2,a2)
Parameters
- r1: number
- g1: number
- b1: number
- a1: number
- r2: number
- g2: number
- b2: number
- a2: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:1112

sortChildren

sortChildren(sorter: ((a: RenderElement, b: RenderElement) => number)): void
Parameters
- sorter: ((a: RenderElement, b: RenderElement) => number)
  - - (a: RenderElement, b: RenderElement): number
    - Parameters
      
      a: RenderElement
      
      b: RenderElement
      
      Returns number
Returns void
Inherited from DirectRenderElement.sortChildren
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:283

useStandardMatrix

useStandardMatrix(): void
Switch back from manual mode to standard mode.

Returns void
Inherited from DirectRenderElement.useStandardMatrix
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/RenderTree.ts:214

Class CustomShadedFrameElement

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CustomShadedFrameElement

Properties

_children

Private _dirty

Private _frame

color1

color2

color3

color4

material

name

regX

regY

Private tex1

Private tex2

Private tex3

Private tex4

visible

Accessors

blendMode

Returns BlendMode

Parameters

value: BlendMode

Returns void

frame

Returns SpriteSheetFrame

Parameters

v: SpriteSheetFrame

Returns void

height

Returns number

Parameters

v: number

Returns void

matrix

Returns AffineMatrix

Parameters

v: AffineMatrix

Returns void

numChildren

Returns number

parent

Returns RenderElement

rotation

Returns number

Parameters

v: number

Returns void

scale

Returns number

Parameters

v: number

Returns void

scaleX

Returns number

Parameters

v: number

Returns void

scaleY

Returns number

Parameters

v: number

Returns void

width

Returns number

Parameters

v: number

Returns void

worldMatrix

Returns AffineMatrix

x

`Private` _dirty

`Private` _frame

`Private` tex1

`Private` tex2

`Private` tex3

`Private` tex4

`Private` prepare