|
void | Consume (HPS.DistantLightKit in_kit) |
| Completely replaces all settings on this DistantLightKey with those set on the specified kit and resets the kit. More...
|
|
override void | Dispose () |
|
| DistantLightKey () |
| The default constructor creates an uninitialized DistantLightKey object. The Type() function will return Type.None. More...
|
|
| 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. More...
|
|
| DistantLightKey (HPS.DistantLightKey in_that) |
| The copy constructor creates a DistantLightKey object that shares the underlying smart-pointer of the source DistantLightKey. More...
|
|
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). More...
|
|
void | Set (HPS.DistantLightKit in_kit) |
| Replace those settings on this DistantLightKey with those set on the specified kit. More...
|
|
HPS.DistantLightKey | SetCameraRelative (bool in_state) |
| Sets the camera-relative setting for this DistantLightKey. More...
|
|
HPS.DistantLightKey | SetColor (HPS.RGBAColor in_rgba_color) |
| Sets the RGBA color to use for this DistantLightKey. More...
|
|
HPS.DistantLightKey | SetColorByIndex (float in_index) |
| Sets the color index to use for this DistantLightKey. More...
|
|
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. More...
|
|
void | Show (out HPS.DistantLightKit out_kit) |
| Copy the contents of this DistantLightKey into the specified kit. More...
|
|
bool | ShowCameraRelative (out bool out_state) |
| Shows the camera-relative setting for this DistantLightKey. More...
|
|
bool | ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index) |
| Shows the color for this DistantLightKey. More...
|
|
bool | ShowDirection (out HPS.Vector out_vector) |
| Shows the direction in which this DistantLightKey lies. More...
|
|
HPS.DistantLightKey | UnsetColor () |
| Removes the color (RGBA or material index) set on this DistantLightKey. More...
|
|
override void | Dispose () |
|
| GeometryKey () |
| The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type.None. More...
|
|
| GeometryKey (HPS.Key in_that) |
| This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More...
|
|
| GeometryKey (HPS.GeometryKey in_that) |
| The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. More...
|
|
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). More...
|
|
HPS.GeometryKey | SetPriority (int in_priority) |
| Assigns a drawing priority value to the geometry. It affects the order in which the geometry is rendered when the rendering algorithm is set to Priority. All geometry has a default drawing priority assigned based on the order of insertion into the segment. More...
|
|
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
| Sets user data on this key. More...
|
|
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
| Sets user data on this key. More...
|
|
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
| Sets user data on this key. More...
|
|
bool | ShowBounding (out HPS.BoundingKit out_kit) |
| Shows the bounding of this geometry. More...
|
|
bool | ShowPriority (out int out_priority) |
| Shows the drawing priority. More...
|
|
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
| Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key. More...
|
|
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
| Shows the all the references to this key. More...
|
|
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
| Shows the user data at a given index for this key. More...
|
|
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
| Shows all user data for this key. More...
|
|
ulong | ShowUserDataCount () |
| Get the number of user data indices set on this key. More...
|
|
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
| Shows the indices of all user data set on this key. More...
|
|
HPS.GeometryKey | UnsetAllUserData () |
| Removes all user data from this key. More...
|
|
HPS.GeometryKey | UnsetPriority () |
| Removes the drawing priority setting. More...
|
|
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
| Removes the user data at the given index from this key. More...
|
|
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
| Removes the user data at the given indices from this key. More...
|
|
virtual void | Assign (HPS.Key in_that) |
| Share the underlying smart-pointer of the Key source. More...
|
|
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
| Performs a deep copy of the database object referred to by this key into a segment pointed to by in_destination. If the copied key includes other keys or has child nodes, they will be recursively copied. Include links will also be copied, however, link targets will not be copied. More...
|
|
void | Delete () |
| Removes the database object referred to by this key. More...
|
|
override void | Dispose () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Key in_that) |
| Determines whether the database objects pointed to by this key and in_that are the same. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More...
|
|
ulong | GetHash () |
| Returns a hash code for the key. More...
|
|
override int | GetHashCode () |
|
bool | HasOwner () |
| - Returns
- Indicates whether this key has an owner or not.
|
|
| Key () |
| An uninitialized key refers to no database object and Type() will return Type.None. More...
|
|
| Key (HPS.Key in_that) |
| Shares a reference to a database object referred to by in_that. More...
|
|
| Key (HPS.Control in_control) |
| Initializes a key associated to the Control in_control. More...
|
|
void | MoveTo (HPS.SegmentKey in_new_owner) |
| Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More...
|
|
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). More...
|
|
HPS.SegmentKey | Owner () |
| - Returns
- The segment containing this key.
|
|
HPS.SegmentKey | Up () |
| - Returns
- The segment containing this key.
|
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
| Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
|
|
bool | HasType (HPS.Type in_mask) |
| This function indicates whether this Object has the given Type mask. More...
|
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
| Resets this object to its initial, uninitialized state. More...
|
|
virtual HPS.Type | Type () |
| This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
|
|
The DistantLightKey class is a smart pointer to a database object. It is a handle to a distant light inserted via SegmentKey.InsertDistantLight.