Enumeration CarbonMaterialShadingModel

The CarbonMaterialShadingModel enum is used to define the shading model used to render a CarbonMaterial.

Constructors

`Protected`constructor

new CarbonMaterialShadingModel(do_not_, construct_, this_, type_): CarbonMaterialShadingModel
Parameters
- do_not_: undefined
- construct_: undefined
- this_: undefined
- type_: undefined
Returns CarbonMaterialShadingModel

Values

`Static` `Readonly`Anisotropic

Anisotropic = 3

The standard physically-based shading model extended by a anisotropic shading model.

`Static` `Readonly`ClearCoat

ClearCoat = 2

The standard physically-based shading model extended by a clear coat shading model.

`Static` `Readonly`Cloth

Cloth = 4

The standard physically-based shading model extended by a cloth shading model.

`Static` `Readonly`Count

Count = 7

The standard physically-based shading model with a two-sided transmissive shading model for thin object rendering, like foliage or curtains.

`Static` `Readonly`Foliage

Foliage = 6

The standard physically-based shading model with a two-sided transmissive shading model for thin object rendering, like foliage or curtains.

`Static` `Readonly`Standard

Standard = 1

The standard physically-based shading model.

`Static` `Readonly`Subsurface

Subsurface = 5

The standard physically-based shading model extended by a sub-surface scattering model.

`Static` `Readonly`Unlit

Unlit = 0

The unlit shading model.

Note

Currently unsupported.

Methods

`Static`addFlag

addFlag<T, K>(value, bits): K
Adds the flag bits to the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`combineFlags

combineFlags<T>(values): EnumValueTyped<T, number>
Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]
  The array of values to be combined using bitwise-or operator.
Returns EnumValueTyped<T, number>
The combined enum value.

`Static`getEnumName

getEnumName<T>(index): string
Type Parameters
- T
Parameters
- index: EnumValue<T, number>
Returns string
Obsolete
Compatibility

`Static`getEnumNames

getEnumNames(): string[]
Returns string[]
Obsolete
Compatibility

`Static`getEnumValue

getEnumValue(index): number
Parameters
- index: number
Returns number
Obsolete
Compatibility

`Static`getEnumValues

getEnumValues(): number[]
Returns number[]
Obsolete
Compatibility

`Static`getNameForValue

getNameForValue<T>(enumValue): string
Gets the name for the enumeration value that matches the specified enumValue.
Type Parameters
- T
Parameters
- enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enumeration value.
Returns string
The enumeration value or undefined if not found.

`Static`getNames

getNames(): string[]
Gets the enumeration names

Returns string[]
The enumeration names.

`Static`getValueAtIndex

getValueAtIndex<T>(index): EnumValueTyped<T, number>
Gets the enumeration value at the specified index.
Type Parameters
- T = number
Parameters
- index: number
  The index.
Returns EnumValueTyped<T, number>
The enumeration value or undefined if not found.

`Static`getValues

getValues<T>(): EnumValueTyped<T, number>[]
Gets the enumeration values
Type Parameters
- T = any
Returns EnumValueTyped<T, number>[]
The enumeration values.

`Static`hasFlag

hasFlag<T, K>(value, bits): boolean
Determines if the enum value has the flags set.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`hasFlagChanged

hasFlagChanged<T, K>(previousValue, newValue, bits): boolean
Determines if the enum bits were changed from previousValue to currentValue.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- previousValue: K
- newValue: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`iterateNames

iterateNames(): Generator<string, any, any>
Iterates the enumeration names

Returns Generator<string, any, any>
The enumeration names.

`Static`iterateValues

iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>
Iterates the enumeration values
Type Parameters
- T = any
Returns Generator<EnumValueTyped<T, number>, any, any>
The enumeration values.

`Static`removeFlag

removeFlag<T, K>(value, bits): K
Removes the flag bits from the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`splitFlags

splitFlags<T>(value): EnumValueTyped<T, number>[]
Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enum value to have it's value split using bitwise-and operator.
Returns EnumValueTyped<T, number>[]
An array of each "bit flag" set in the enum.

Enumeration CarbonMaterialShadingModel

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns CarbonMaterialShadingModel

Values

Static ReadonlyAnisotropic

Static ReadonlyClearCoat

Static ReadonlyCloth

Static ReadonlyCount

Static ReadonlyFoliage

Static ReadonlyStandard

Static ReadonlySubsurface

Static ReadonlyUnlit

Note

Methods

StaticaddFlag

Type Parameters

Parameters

Returns K

StaticcombineFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetEnumName

Type Parameters

Parameters

Returns string

Obsolete

StaticgetEnumNames

Returns string[]

Obsolete

StaticgetEnumValue

Parameters

Returns number

Obsolete

StaticgetEnumValues

Returns number[]

Obsolete

StaticgetNameForValue

Type Parameters

Parameters

Returns string

StaticgetNames

Returns string[]

StaticgetValueAtIndex

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetValues

Type Parameters

Returns EnumValueTyped<T, number>[]

StatichasFlag

Type Parameters

Parameters

Returns boolean

StatichasFlagChanged

Type Parameters

Parameters

Returns boolean

StaticiterateNames

Returns Generator<string, any, any>

StaticiterateValues

Type Parameters

Returns Generator<EnumValueTyped<T, number>, any, any>

StaticremoveFlag

Type Parameters

Parameters

Returns K

StaticsplitFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>[]

Settings

On This Page

`Protected`constructor

`Static` `Readonly`Anisotropic

`Static` `Readonly`ClearCoat

`Static` `Readonly`Cloth

`Static` `Readonly`Count

`Static` `Readonly`Foliage

`Static` `Readonly`Standard

`Static` `Readonly`Subsurface

`Static` `Readonly`Unlit

`Static`addFlag

`Static`combineFlags

`Static`getEnumName

`Static`getEnumNames

`Static`getEnumValue

`Static`getEnumValues

`Static`getNameForValue

`Static`getNames

`Static`getValueAtIndex

`Static`getValues

`Static`hasFlag

`Static`hasFlagChanged

`Static`iterateNames

`Static`iterateValues

`Static`removeFlag

`Static`splitFlags