DistantLightKey

class HPS.DistantLightKey : HPS.GeometryKey

The DistantLightKey class is a smart pointer to a database object. It is a handle to a distant light inserted via SegmentKey.InsertDistantLight.

Public Functions

void Consume (HPS.DistantLightKit in_kit)

Completely replaces all settings on this DistantLightKey with those set on the specified kit and resets the kit.

Param in_kit:The kit from which to get the settings to replace on this DistantLightKey.

override void Dispose ()

DistantLightKey ()

The default constructor creates an uninitialized DistantLightKey object. The Type() function will return Type.None.

DistantLightKey (HPS.DistantLightKey in_that)

The copy constructor creates a DistantLightKey object that shares the underlying smart-pointer of the source DistantLightKey.

Param in_that:The source DistantLightKey to copy.

DistantLightKey (HPS.Key in_that)

This constructor creates a DistantLightKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a DistantLight key. Otherwise the copy will fail and the resulting DistantLightKey will be invalid.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.DistantLightKit in_kit)

Replace those settings on this DistantLightKey with those set on the specified kit.

Param in_kit:The kit from which to get the settings to replace on this DistantLightKey.

HPS.DistantLightKey SetCameraRelative (bool in_state)

Sets the camera-relative setting for this DistantLightKey.

See also

SetDirection

Param in_state:Whether the direction of this DistantLightKey is treated as being in object space or camera-relative space. Return:A reference to this DistantLightKey.

HPS.DistantLightKey SetColor (HPS.RGBAColor in_rgba_color)

Sets the RGBA color to use for this DistantLightKey.

Param in_rgba_color:  The RGBA color to use for this DistantLightKey. Return:A reference to this DistantLightKey.

HPS.DistantLightKey SetColorByIndex (float in_index)

Sets the color index to use for this DistantLightKey.

Param in_index:The color index to use for this DistantLightKey. Return:A reference to this DistantLightKey.

HPS.DistantLightKey SetDirection (HPS.Vector in_vector)

Sets the direction in which this DistantLightKey lies. The rays emitted by this light will travel in the opposite direction of this vector.

See also

SetCameraRelative

Param in_vector:  The direction in which this DistantLightKey lies. The vector will either be treated as being in object space or in camera-relative units depending on the setting passed SetCameraRelative. Return:A reference to this DistantLightKey.

void Show (out HPS.DistantLightKit out_kit)

Copy the contents of this DistantLightKey into the specified kit.

Param out_kit:The kit to populate with the contents of this DistantLightKey.

bool ShowCameraRelative (out bool out_state)

Shows the camera-relative setting for this DistantLightKey.

Param out_state:  Whether the direction of this DistantLightKey is treated as being in object space or camera-relative space. Return:true if a camera-relative setting was specified, false otherwise.

bool ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index)

Shows the color for this DistantLightKey.

Param out_type:The type of color for the distant light. Param out_rgba_color:  The RGBA color for the distant light. This is only valid if out_type is Material.Type.RGBAColor. Param out_index:  The material index for the distant light. This is only valid if out_type is Material.Type.MaterialIndex. Return:true if a color was set, false otherwise.

bool ShowDirection (out HPS.Vector out_vector)

Shows the direction in which this DistantLightKey lies.

Param out_vector:  The direction in which this DistantLightKey lies. Return:true if a direction was set, false otherwise.

HPS.DistantLightKey UnsetColor ()

Removes the color (RGBA or material index) set on this DistantLightKey.

Return:A reference to this DistantLightKey.