Class AbstractGeometryImg

Class used for customizable turn images

Hierarchy (View Summary)

ImgBase
- AbstractGeometryImg

Index

Constructors

Properties

Accessors

imageType isValid pointerId uid

Methods

getRenderableImage getRenderableImageBytes registerAutoReleaseObject create

Constructors

`Protected`constructor

new AbstractGeometryImg(pointerId: number): AbstractGeometryImg
Parameters
- pointerId: number
Returns AbstractGeometryImg
Overrides ImgBase.constructor
- Defined in core/images.ts:933

Properties

`Protected`_pointerId

_pointerId: number

Accessors

imageType

get imageType(): ImageFileFormat
Get the image type

Returns ImageFileFormat
The image type
Inherited from ImgBase.imageType
- Defined in core/images.ts:767

isValid

get isValid(): boolean
Check if the image is valid

Returns boolean
True if the image is valid, false otherwise
Inherited from ImgBase.isValid
- Defined in core/images.ts:777

pointerId

get pointerId(): number
Returns number
Inherited from ImgBase.pointerId
- Defined in core/images.ts:749

uid

get uid(): number
Get the image unique ID

Returns number
The image ID
Inherited from ImgBase.uid
- Defined in core/images.ts:757

Methods

getRenderableImage

getRenderableImage(
    size?: { height: number; width: number },
    format?: ImageFileFormat,
    renderSettings?: AbstractGeometryImageRenderSettings,
): RenderableImg | undefined
Get the renderable image with custom settings
Parameters
- Optionalsize: { height: number; width: number }
  The optional size as { width, height }
- format: ImageFileFormat = ImageFileFormat.png
  The image format (default: png)
- OptionalrenderSettings: AbstractGeometryImageRenderSettings
  Optional render settings
Returns RenderableImg | undefined
The renderable image or undefined if not valid
Overrides ImgBase.getRenderableImage
- Defined in core/images.ts:953

getRenderableImageBytes

getRenderableImageBytes(
size?: { height: number; width: number },
format?: ImageFileFormat,
): Uint8Array<ArrayBufferLike> | undefined
Get the image data as a Uint8Array
Parameters
- Optionalsize: { height: number; width: number }
  The optional size as { width, height }
- format: ImageFileFormat = ImageFileFormat.png
  The image format (default: png)
Returns Uint8Array<ArrayBufferLike> | undefined
The image data or undefined if not valid
Inherited from ImgBase.getRenderableImageBytes
- Defined in core/images.ts:789

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from ImgBase.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:24

`Static`create

create(pointerId: number): AbstractGeometryImg
Creates a new AbstractGeometryImg instance
Parameters
- pointerId: number
  The native pointer ID
Returns AbstractGeometryImg
A new AbstractGeometryImg instance
- Defined in core/images.ts:942