Class BitMask

Create a new BitMask instance.

Param: states

An object containing valid states and their corresponding initial boolean values (default is null).

Hierarchy

Number
- BitMask

Index

Properties

`Readonly` states

states: Record<string, string>

The enum associated with this structure.

`Private` #value

#value: number

The real value behind the bitmask instance.

`Private` #validStates

#validStates: Map<string, number>

The structure of valid states and their associated values.

Accessors

isEmpty

get isEmpty(): boolean
True if this bitmask is empty (no active states).

Returns boolean

Methods

hasState

hasState(state): boolean
Check if a specific state is active.
Parameters
- state: string
  The state to check.
Returns boolean
True if the state is active, false otherwise.

addState

addState(state): void
Add a state to the bitmask.
Parameters
- state: string
  The state to add.
Returns void
Throws
Throws an error if the provided state is not valid.

removeState

removeState(state): void
Remove a state from the bitmask.
Parameters
- state: string
  The state to remove.
Returns void
Throws
Throws an error if the provided state is not valid.

toggleState

toggleState(state, enabled?): number
Toggle the state of a specific state in the bitmask.
Parameters
- state: string
  The state to toggle.
- Optional enabled: boolean
  Toggle on (true) or off (false)? If undefined, the state is switched automatically.
Returns number
Throws
Throws an error if the provided state is not valid.

clear

clear(): void
Clear the bitmask, setting all states to inactive.

Returns void

valueOf

valueOf(): number
Get the current value of the bitmask.

Returns number
The current value of the bitmask.

Overrides Number.valueOf

toString

toString(): string
Get a string representation of the bitmask in binary format.

Returns string
The string representation of the bitmask.

Overrides Number.toString

isCompatible

isCompatible(otherBitMask): boolean
Checks if two bitmasks structures are compatible (the same valid states).
Parameters
- otherBitMask: BitMask
  The bitmask structure to compare with.
Returns boolean
True if the two bitmasks have the same structure, false otherwise.

toJSON

toJSON(): string
Serializes the bitmask to a JSON string.

Returns string
The JSON string representing the bitmask.

toObject

toObject(): Object
Convert value of this BitMask to object representation according to structure.

Returns Object
The data represented by the bitmask.

clone

clone(): BitMask
Creates a clone of this BitMask instance.

Returns BitMask
A new BitMask instance with the same value and valid states as this instance.

`Private` #generateValidStates

#generateValidStates(states?): void
Generates the valid states and their associated values.
Parameters
- Optional states: Record<string, boolean>
  The structure defining the valid states and their associated values.
Returns void

`Private` #generateEnum

#generateEnum(): void
Generates an enum based on the provided valid states.

Returns void

`Private` #computeValue

#computeValue(initialStates?): number
Calculate the default value of the bitmask based on the initial states
Parameters
- Optional initialStates: Record<string, boolean> = {}
  The structure defining the valid states and their associated values.
Returns number

`Private` #checkState

#checkState(state): void
Checks a state and throws an error if it doesn't exist.
Parameters
- state: string
  Name of the state to check.
Returns void

`Static` fromJSON

fromJSON(jsonString): BitMask
Creates a new BitMask instance from a JSON string.
Parameters
- jsonString: string
  The JSON string representing the bitmask.
Returns BitMask
A new BitMask instance created from the JSON string.

`Static` generateShaderBitMaskConstants

generateShaderBitMaskConstants(states): string
Generates shader constants based on the provided states.
Parameters
- states: string[]
  An array containing valid states.
Returns string
Shader bit mask constants generated from the states.