Class Image

No Self In File

Hierarchy

Handle<image>
- Image

Index

Constructors

Properties

Accessors

Methods

destroy setAboveWater setColor setConstantHeight setPosition setRender setType show fromHandle getObject initFromHandle

Constructors

constructor

new Image(file: string, sizeX: number, sizeY: number, sizeZ: number, posX: number, posY: number, posZ: number, originX: number, originY: number, originZ: number, imageType: ImageType): Image
Parameters
- file: string
- sizeX: number
- sizeY: number
- sizeZ: number
- posX: number
- posY: number
- posZ: number
- originX: number
- originY: number
- originZ: number
- imageType: ImageType
Returns Image
Overrides Handle.constructor
- Defined in w3ts/handles/image.ts:14

Properties

`Readonly` handle

handle: image

Accessors

id

get id(): number
Returns number
Inherited from Handle.id
- Defined in w3ts/handles/handle.ts:15

Methods

destroy

destroy(): void
Returns void
- Defined in w3ts/handles/image.ts:22

setAboveWater

setAboveWater(flag: boolean, useWaterAlpha: boolean): void
Parameters
- flag: boolean
- useWaterAlpha: boolean
Returns void
- Defined in w3ts/handles/image.ts:26

setColor

setColor(red: number, green: number, blue: number, alpha: number): void
Parameters
- red: number
- green: number
- blue: number
- alpha: number
Returns void
- Defined in w3ts/handles/image.ts:30

setConstantHeight

setConstantHeight(flag: boolean, height: number): void
Parameters
- flag: boolean
- height: number
Returns void
- Defined in w3ts/handles/image.ts:34

setPosition

setPosition(x: number, y: number, z: number): void
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in w3ts/handles/image.ts:38

setRender

setRender(flag: boolean): void
Parameters
- flag: boolean
Returns void
- Defined in w3ts/handles/image.ts:42

setType

setType(imageType: ImageType): void
Parameters
- imageType: ImageType
Returns void
- Defined in w3ts/handles/image.ts:46

show

show(flag: boolean): void
Parameters
- flag: boolean
Returns void
- Defined in w3ts/handles/image.ts:50

`Static` fromHandle

fromHandle(handle: image): Image
Parameters
- handle: image
Returns Image
- Defined in w3ts/handles/image.ts:54

`Static` `Protected` getObject

getObject(handle: handle): any
Parameters
- handle: handle
Returns any
Inherited from Handle.getObject
- Defined in w3ts/handles/handle.ts:23

`Static` initFromHandle

initFromHandle(): boolean
Returns boolean
Inherited from Handle.initFromHandle
- Defined in w3ts/handles/handle.ts:19