Inheritance diagram for HPS.DistantLightKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

void Consume (HPS.DistantLightKit in_kit)
 
override void Dispose ()
 
 DistantLightKey ()
 
 DistantLightKey (HPS.Key in_that)
 
 DistantLightKey (HPS.DistantLightKey in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.DistantLightKit in_kit)
 
HPS.DistantLightKey SetCameraRelative (bool in_state)
 
HPS.DistantLightKey SetColor (HPS.RGBAColor in_rgba_color)
 
HPS.DistantLightKey SetColorByIndex (float in_index)
 
HPS.DistantLightKey SetDirection (HPS.Vector in_vector)
 
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)
 
HPS.DistantLightKey UnsetColor ()
 
- Public Member Functions inherited from HPS.GeometryKey
override void Dispose ()
 
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
override HPS.Type ObjectType ()
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
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.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
override HPS.Type ObjectType ()
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ DistantLightKey() [1/3]

HPS.DistantLightKey.DistantLightKey ( )
inline

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

◆ DistantLightKey() [2/3]

HPS.DistantLightKey.DistantLightKey ( HPS.Key  in_that)
inline

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.

◆ DistantLightKey() [3/3]

HPS.DistantLightKey.DistantLightKey ( HPS.DistantLightKey  in_that)
inline

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

Parameters
in_thatThe source DistantLightKey to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe kit from which to get the settings to replace on this DistantLightKey.

◆ ObjectType()

override HPS.Type HPS.DistantLightKey.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.DistantLightKey.Set ( HPS.DistantLightKit  in_kit)
inline

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

Parameters
in_kitThe kit from which to get the settings to replace on this DistantLightKey.

◆ SetCameraRelative()

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

Sets the camera-relative setting for this DistantLightKey.

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

◆ SetColor()

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

Sets the RGBA color to use for this DistantLightKey.

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

◆ SetColorByIndex()

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

Sets the color index to use for this DistantLightKey.

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

◆ SetDirection()

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

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

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

◆ Show()

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

Copy the contents of this DistantLightKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this DistantLightKey.

◆ ShowCameraRelative()

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

Shows the camera-relative setting for this DistantLightKey.

Parameters
out_stateWhether the direction of this DistantLightKey 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.DistantLightKey.ShowColor ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_rgba_color,
out float  out_index 
)
inline

Shows the color for this DistantLightKey.

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.DistantLightKey.ShowDirection ( out HPS.Vector  out_vector)
inline

Shows the direction in which this DistantLightKey lies.

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

◆ UnsetColor()

HPS.DistantLightKey HPS.DistantLightKey.UnsetColor ( )
inline

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

Returns
A reference to this DistantLightKey.

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