DistantLightKit

class HPS.DistantLightKit : public HPS.Kit 

The DistantLightKit class is a user space object. It is a kit analog to a DistantLightKey.

Public Functions

void Consume (HPS.DistantLightKit in_kit)

Copies the source DistantLightKit into this DistantLightKit and resets the source kit.

Param in_kit: The source DistantLightKit to consume.

override void Dispose ()

DistantLightKit (): The default constructor creates an empty DistantLightKit object.

DistantLightKit (HPS.DistantLightKit in_kit)

The copy constructor creates a new DistantLightKit object that contains the same settings as the source DistantLightKit.

Param in_kit: The source DistantLightKit to copy.

override bool Empty ()

Indicates whether this DistantLightKit has any values set on it.

Return: true if no values are set on this DistantLightKit, false otherwise.

bool Equals (HPS.DistantLightKit in_kit)

Check if the source DistantLightKit is equivalent to this DistantLightKit.

Param in_kit: The source DistantLightKit to compare to this DistantLightKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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)

Copies the source DistantLightKit into this DistantLightKit.

Param in_kit: The source DistantLightKit to copy.

HPS.DistantLightKit SetCameraRelative (bool in_state)

Sets the camera-relative setting for this DistantLightKit.

See: SetDirection
See: Default value

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

HPS.DistantLightKit SetColor (HPS.RGBAColor in_rgba_color)

Sets the RGBA color to use for this DistantLightKit.

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

HPS.DistantLightKit SetColorByIndex (float in_index)

Sets the color index to use for this DistantLightKit.

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

HPS.DistantLightKit SetDirection (HPS.Vector in_vector)

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

See: SetCameraRelative
See: Default value

Param in_vector: The direction in which this DistantLightKit 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 DistantLightKit.

HPS.DistantLightKit SetPriority (int in_priority)

Assigns a specific drawing priority value to the DistantLightKit. It affects the order in which the contents of the owning segment are drawn if and only if the rendering algorithm is set to Priority.

See: SubwindowKit.SetPriority()
See: SubwindowKit.SetRenderingAlgorithm()

Param in_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: A reference to this object.

HPS.DistantLightKit SetUserData (IntPtr in_index, byte[] in_data)

Sets user data on this kit.

Param in_index: The index of the user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this kit.

HPS.DistantLightKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)

Sets user data on this kit.

Param in_index: The index of the user data to set.
Param in_bytes: The number of bytes of user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this kit.

HPS.DistantLightKit SetUserData (IntPtr[] in_indices, byte[][] in_data)

Sets user data on this kit.

Param in_indices: An array of user data indices to set.
Param in_data: An array of bytes of user data to set.
Return: A reference to this kit.

void Show (out HPS.DistantLightKit out_kit)

Copies this DistantLightKit into the given DistantLightKit.

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

bool ShowCameraRelative (out bool out_state)

Shows the camera-relative setting for this DistantLightKit.

Param out_state: Whether the direction of this DistantLightKit 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 DistantLightKit.

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 DistantLightKit lies.

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

bool ShowPriority (out int out_priority)

Shows the drawing priority for this DistantLightKit.

Param out_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: true if drawing priority was specified, false otherwise.

bool ShowUserData (IntPtr in_index, out byte[] out_data)