Class PhotometricLightProfileOptions

Descriptor structure used for initialization of a PhotometricLightProfile.

Index

Constructors

Properties

_horizontalAngles _iesType _type _values _verticalAngles

Accessors

horizontalAngles iesType type values verticalAngles

Methods

assign clone isEqual isEqual

Constructors

constructor

new PhotometricLightProfileOptions(type?, verticalAngles?, horizontalAngles?, values?, iesType?): PhotometricLightProfileOptions
Parameters
- Optionaltype: EnumValue<PhotometricLightProfileType, number>
- OptionalverticalAngles: Iterable<rsx.Degree>
- OptionalhorizontalAngles: Iterable<rsx.Degree>
- Optionalvalues: Iterable<number>
- OptionaliesType: EnumValue<IESPhotometricType, number>
Returns PhotometricLightProfileOptions

Properties

`Protected`_horizontalAngles

_horizontalAngles: rsx.Degree[]

`Protected`_iesType

_iesType: EnumValue<IESPhotometricType, number>

`Protected`_type

_type: EnumValue<PhotometricLightProfileType, number>

`Protected`_values

_values: number[]

`Protected`_verticalAngles

_verticalAngles: rsx.Degree[]

Accessors

horizontalAngles

get horizontalAngles(): Iterable<rsx.Degree>
Horizontal angles at which samples were recorded at, in incrementing order.

Returns Iterable<rsx.Degree>
set horizontalAngles(value): void
Parameters
- value: Iterable<rsx.Degree> | rsx.Degree[]
Returns void

iesType

get iesType(): EnumValue<IESPhotometricType, number>
IES light distribution. Only relevant if the profile represents an IES profile.

Returns EnumValue<IESPhotometricType, number>
set iesType(value): void
Parameters
- value: EnumValue<IESPhotometricType, number>
Returns void

type

get type(): EnumValue<PhotometricLightProfileType, number>
Type of the photometric profile represented.

Returns EnumValue<PhotometricLightProfileType, number>
set type(value): void
Parameters
- value: EnumValue<PhotometricLightProfileType, number>
Returns void

values

get values(): Iterable<number>
Recorded values for each sampling point in candelas (measuring luminous intensity).

Values must be in order: All vertical angle values for 1st horizontal angle, followed by all vertical angle values for 2nd horizontal angle, etc. Angles are specified in VerticalAngles and HorizontalAngles.

Returns Iterable<number>
set values(value): void
Parameters
- value: number[] | Iterable<number>
Returns void

verticalAngles

get verticalAngles(): Iterable<rsx.Degree>
Vertical angles at which samples were recorded at, in incrementing order.

Returns Iterable<rsx.Degree>
set verticalAngles(value): void
Parameters
- value: Iterable<rsx.Degree> | rsx.Degree[]
Returns void

Methods

assign

assign(other): PhotometricLightProfileOptions
Copies all properties defined by the prototype of PhotometricLightProfileOptions from other to this instance.
Parameters
- other: Immutable<PhotometricLightProfileOptions>
Returns PhotometricLightProfileOptions

clone

clone(): PhotometricLightProfileOptions
Clones this instance and returns a new PhotometricLightProfileOptions with identical values.

Returns PhotometricLightProfileOptions

isEqual

isEqual(this, other): boolean
Determines if this PhotometricLightProfileOptions instance is equal to the other instance.
Parameters
- this: Immutable<PhotometricLightProfileOptions>
- other: Immutable<PhotometricLightProfileOptions>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both PhotometricLightProfileOptions instances are equal.
Parameters
- lhs: Immutable<PhotometricLightProfileOptions>
- rhs: Immutable<PhotometricLightProfileOptions>
Returns boolean