Inheritance diagram for HPS.DistantLightKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.DistantLightKit in_kit)
 
override void Dispose ()
 
 DistantLightKit ()
 
 DistantLightKit (HPS.DistantLightKit in_kit)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.DistantLightKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.DistantLightKit in_kit)
 
HPS.DistantLightKit SetCameraRelative (bool in_state)
 
HPS.DistantLightKit SetColor (HPS.RGBAColor in_rgba_color)
 
HPS.DistantLightKit SetColorByIndex (float in_index)
 
HPS.DistantLightKit SetDirection (HPS.Vector in_vector)
 
HPS.DistantLightKit SetPriority (int in_priority)
 
HPS.DistantLightKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.DistantLightKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.DistantLightKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.DistantLightKit out_kit)
 
bool ShowCameraRelative (out bool out_state)
 
bool ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index)
 
bool ShowDirection (out HPS.Vector out_vector)
 
bool ShowPriority (out int out_priority)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
HPS.DistantLightKit UnsetAllUserData ()
 
HPS.DistantLightKit UnsetCameraRelative ()
 
HPS.DistantLightKit UnsetColor ()
 
HPS.DistantLightKit UnsetDirection ()
 
HPS.DistantLightKit UnsetEverything ()
 
HPS.DistantLightKit UnsetPriority ()
 
HPS.DistantLightKit UnsetUserData (IntPtr in_index)
 
HPS.DistantLightKit UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.DistantLightKit a, HPS.DistantLightKit b)
 
static bool operator== (HPS.DistantLightKit a, HPS.DistantLightKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ DistantLightKit() [1/2]

HPS.DistantLightKit.DistantLightKit ( )
inline

The default constructor creates an empty DistantLightKit object.

◆ DistantLightKit() [2/2]

HPS.DistantLightKit.DistantLightKit ( HPS.DistantLightKit  in_kit)
inline

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

Parameters
in_kitThe source DistantLightKit to copy.

Member Function Documentation

◆ Consume()

void HPS.DistantLightKit.Consume ( HPS.DistantLightKit  in_kit)
inline

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

Parameters
in_kitThe source DistantLightKit to consume.

◆ Empty()

override bool HPS.DistantLightKit.Empty ( )
inlinevirtual

Indicates whether this DistantLightKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.DistantLightKit.Equals ( HPS.DistantLightKit  in_kit)
inline

Check if the source DistantLightKit is equivalent to this DistantLightKit.

Parameters
in_kitThe source DistantLightKit to compare to this DistantLightKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.DistantLightKit.ObjectType ( )
inlinevirtual

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

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

Reimplemented from HPS.Object.

◆ Set()

void HPS.DistantLightKit.Set ( HPS.DistantLightKit  in_kit)
inline

Copies the source DistantLightKit into this DistantLightKit.

Parameters
in_kitThe source DistantLightKit to copy.

◆ SetCameraRelative()

HPS.DistantLightKit HPS.DistantLightKit.SetCameraRelative ( bool  in_state)
inline

Sets the camera-relative setting for this DistantLightKit.

Parameters
in_stateWhether the direction of this DistantLightKit is treated as being in object space or camera-relative space.
Returns
A reference to this DistantLightKit.
See also
SetDirection
Default value

◆ SetColor()

HPS.DistantLightKit HPS.DistantLightKit.SetColor ( HPS.RGBAColor  in_rgba_color)
inline

Sets the RGBA color to use for this DistantLightKit.

Parameters
in_rgba_colorThe RGBA color to use for this DistantLightKit.
Returns
A reference to this DistantLightKit.

◆ SetColorByIndex()

HPS.DistantLightKit HPS.DistantLightKit.SetColorByIndex ( float  in_index)
inline

Sets the color index to use for this DistantLightKit.

Parameters
in_indexThe color index to use for this DistantLightKit.
Returns
A reference to this DistantLightKit.

◆ SetDirection()

HPS.DistantLightKit HPS.DistantLightKit.SetDirection ( HPS.Vector  in_vector)
inline

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

Parameters
in_vectorThe 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.
Returns
A reference to this DistantLightKit.
See also
SetCameraRelative
Default value

◆ SetPriority()

HPS.DistantLightKit HPS.DistantLightKit.SetPriority ( int  in_priority)
inline

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.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetUserData() [1/3]

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

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

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

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

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

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ Show()

void HPS.DistantLightKit.Show ( out HPS.DistantLightKit  out_kit)
inline

Copies this DistantLightKit into the given DistantLightKit.

Parameters
out_kitThe DistantLightKit to populate with the contents of this DistantLightKit.

◆ ShowCameraRelative()

bool HPS.DistantLightKit.ShowCameraRelative ( out bool  out_state)
inline

Shows the camera-relative setting for this DistantLightKit.

Parameters
out_stateWhether the direction of this DistantLightKit is treated as being in object space or camera-relative space.
Returns
true if a camera-relative setting was specified, false otherwise.

◆ ShowColor()

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

Shows the color for this DistantLightKit.

Parameters
out_typeThe type of color for the distant light.
out_rgba_colorThe RGBA color for the distant light. This is only valid if out_type is Material.Type.RGBAColor.
out_indexThe material index for the distant light. This is only valid if out_type is Material.Type.MaterialIndex.
Returns
true if a color was set, false otherwise.

◆ ShowDirection()

bool HPS.DistantLightKit.ShowDirection ( out HPS.Vector  out_vector)
inline

Shows the direction in which this DistantLightKit lies.

Parameters
out_vectorThe direction in which this DistantLightKit lies.
Returns
true if a direction was set, false otherwise.

◆ ShowPriority()

bool HPS.DistantLightKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority for this DistantLightKit.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if drawing priority was specified, false otherwise.

◆ ShowUserData() [1/2]

bool HPS.DistantLightKit.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.DistantLightKit.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

ulong HPS.DistantLightKit.ShowUserDataCount ( )
inline

Get the number of user data indices set on this kit.

◆ ShowUserDataIndices()

bool HPS.DistantLightKit.ShowUserDataIndices ( out IntPtr []  out_indices)
inline

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ UnsetAllUserData()

HPS.DistantLightKit HPS.DistantLightKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetCameraRelative()

HPS.DistantLightKit HPS.DistantLightKit.UnsetCameraRelative ( )
inline

Removes the camera-relative setting on this DistantLightKit.

Returns
A reference to this DistantLightKit.

◆ UnsetColor()

HPS.DistantLightKit HPS.DistantLightKit.UnsetColor ( )
inline

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

Returns
A reference to this DistantLightKit.

◆ UnsetDirection()

HPS.DistantLightKit HPS.DistantLightKit.UnsetDirection ( )
inline

Removes the direction set on this DistantLightKit.

Returns
A reference to this DistantLightKit.

◆ UnsetEverything()

HPS.DistantLightKit HPS.DistantLightKit.UnsetEverything ( )
inline

Removes all settings from the DistantLightKit.

Returns
A reference to this DistantLightKit.

◆ UnsetPriority()

HPS.DistantLightKit HPS.DistantLightKit.UnsetPriority ( )
inline

Removes the drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/2]

HPS.DistantLightKit HPS.DistantLightKit.UnsetUserData ( IntPtr  in_index)
inline

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/2]

HPS.DistantLightKit HPS.DistantLightKit.UnsetUserData ( IntPtr []  in_indices)
inline

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.DistantLightKit.cs