REFERENCE MANUAL
Public Member Functions | |
override void | Dispose () |
GeometryKey () | |
The default constructor creates an uninitialized GeometryKey object. More... | |
GeometryKey (HPS.Key in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
GeometryKey (HPS.GeometryKey in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.GeometryKey | SetPriority (int in_priority) |
Assigns a drawing priority value to the geometry. 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 | ShowBoundings (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. 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 smart-pointer. More... | |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
Copies the database object referred to by this key into a segment pointed to by in_destination. 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. More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
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 tied 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. More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
HPS.GeometryKey.GeometryKey | ( | ) |
The default constructor creates an uninitialized GeometryKey object.
The Type() function will return Type::None.
HPS.GeometryKey.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.
HPS.GeometryKey.GeometryKey | ( | HPS.GeometryKey | 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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
Reimplemented in HPS.GridKey, HPS.InfiniteLineKey, HPS.LineKey, HPS.MarkerKey, HPS.MeshKey, HPS.NURBSCurveKey, HPS.NURBSSurfaceKey, HPS.PolygonKey, HPS.ReferenceKey, HPS.ShellKey, HPS.SphereKey, HPS.SpotlightKey, and HPS.TextKey.
HPS.GeometryKey HPS.GeometryKey.SetPriority | ( | int | in_priority | ) |
Assigns a drawing priority value to the geometry.
It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion.
in_priority | The drawing priority; higher priority items are drawn on top of lower priority items. |
HPS.GeometryKey HPS.GeometryKey.SetUserData | ( | IntPtr | in_index, |
ulong | in_bytes, | ||
byte[] | in_data | ||
) |
Sets user data on this key.
in_index | The index of the user data to set. |
in_bytes | The number of bytes of user data to set. |
in_data | The bytes of user data to set. |
HPS.GeometryKey HPS.GeometryKey.SetUserData | ( | IntPtr | in_index, |
byte[] | in_data | ||
) |
Sets user data on this key.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
HPS.GeometryKey HPS.GeometryKey.SetUserData | ( | IntPtr[] | in_indices, |
byte | in_data[][] | ||
) |
Sets user data on this key.
in_data | An array of bytes of user data to set. |
bool HPS.GeometryKey.ShowBoundings | ( | out HPS.BoundingKit | out_kit | ) |
Shows the bounding of this geometry.
bool HPS.GeometryKey.ShowPriority | ( | out int | out_priority | ) |
Shows the drawing priority.
out_priority | The drawing priority; higher priority items are drawn on top of lower priority items. |
ulong HPS.GeometryKey.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.
out_segments | The list of segments which contains references to this key. |
ulong HPS.GeometryKey.ShowReferrers | ( | out HPS.ReferenceKey[] | out_references | ) |
Shows the all the references to this key.
out_references | The list of all references to this key. |
bool HPS.GeometryKey.ShowUserData | ( | IntPtr | in_index, |
out byte[] | out_data | ||
) |
Shows the user data at a given index for this key.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
bool HPS.GeometryKey.ShowUserData | ( | out IntPtr[] | out_indices, |
out byte | out_data[][] | ||
) |
Shows all user data for this key.
out_indices | An array of all user data indices set on this key. |
ulong HPS.GeometryKey.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this key.
bool HPS.GeometryKey.ShowUserDataIndices | ( | out IntPtr[] | out_indices | ) |
Shows the indices of all user data set on this key.
out_indices | The user data indices set on this key. |
HPS.GeometryKey HPS.GeometryKey.UnsetAllUserData | ( | ) |
Removes all user data from this key.
HPS.GeometryKey HPS.GeometryKey.UnsetPriority | ( | ) |
Removes the drawing priority setting.
HPS.GeometryKey HPS.GeometryKey.UnsetUserData | ( | IntPtr | in_index | ) |
Removes the user data at the given index from this key.
in_index | The index of the user data to remove. |
HPS.GeometryKey HPS.GeometryKey.UnsetUserData | ( | IntPtr[] | in_indices | ) |
Removes the user data at the given indices from this key.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |