|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
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 |
|
◆ GeometryKey() [1/3]
HPS.GeometryKey.GeometryKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type.None.
◆ GeometryKey() [2/3]
HPS.GeometryKey.GeometryKey |
( |
HPS.Key |
in_that | ) |
|
|
inline |
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.
- Parameters
-
in_that | The source Key to copy. |
◆ GeometryKey() [3/3]
The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey.
- Parameters
-
◆ ObjectType()
override HPS.Type HPS.GeometryKey.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.
Reimplemented in HPS.GridKey, HPS.InfiniteLineKey, HPS.MarkerKey, HPS.MeshKey, HPS.LineKey, HPS.NURBSCurveKey, HPS.NURBSSurfaceKey, HPS.PolygonKey, HPS.ReferenceKey, HPS.ShellKey, HPS.SphereKey, HPS.SpotlightKey, and HPS.TextKey.
◆ SetPriority()
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.
- Parameters
-
in_priority | The drawing priority; higher priority items are drawn on top of lower priority items. |
- Returns
- A reference to this object.
- See also
- SubwindowKit.SetRenderingAlgorithm()
◆ SetUserData() [1/3]
HPS.GeometryKey HPS.GeometryKey.SetUserData |
( |
IntPtr |
in_index, |
|
|
ulong |
in_bytes, |
|
|
byte [] |
in_data |
|
) |
| |
|
inline |
Sets user data on this key.
- Parameters
-
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. |
- Returns
- A reference to this key.
◆ SetUserData() [2/3]
HPS.GeometryKey HPS.GeometryKey.SetUserData |
( |
IntPtr |
in_index, |
|
|
byte [] |
in_data |
|
) |
| |
|
inline |
Sets user data on this key.
- Parameters
-
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
- Returns
- A reference to this key.
◆ SetUserData() [3/3]
HPS.GeometryKey HPS.GeometryKey.SetUserData |
( |
IntPtr [] |
in_indices, |
|
|
byte |
in_data[][] |
|
) |
| |
|
inline |
Sets user data on this key.
- Parameters
-
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
- Returns
- A reference to this key.
◆ ShowBounding()
Shows the bounding of this geometry.
- Parameters
-
- Returns
- False if no bounding exists.
◆ ShowPriority()
bool HPS.GeometryKey.ShowPriority |
( |
out int |
out_priority | ) |
|
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority | The drawing priority; higher priority items are drawn on top of lower priority items. |
- Returns
- true if a priority was specified, false otherwise.
◆ ShowReferrers() [1/2]
ulong HPS.GeometryKey.ShowReferrers |
( |
out HPS.SegmentKey [] |
out_segments | ) |
|
|
inline |
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.
- Parameters
-
out_segments | The list of segments which contains references to this key. |
- Returns
- The number of segments which contain references to this key.
◆ ShowReferrers() [2/2]
Shows the all the references to this key.
- Parameters
-
out_references | The list of all references to this key. |
- Returns
- The number of references to this key.
◆ ShowUserData() [1/2]
bool HPS.GeometryKey.ShowUserData |
( |
IntPtr |
in_index, |
|
|
out byte [] |
out_data |
|
) |
| |
|
inline |
Shows the user data at a given index for this key.
- Parameters
-
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
- Returns
- true if there is user data at the given index, false otherwise.
◆ ShowUserData() [2/2]
bool HPS.GeometryKey.ShowUserData |
( |
out IntPtr [] |
out_indices, |
|
|
out byte |
out_data[][] |
|
) |
| |
|
inline |
Shows all user data for this key.
- Parameters
-
out_indices | An array of all user data indices set on this key. |
out_data | An array of all user data set on this key. |
- Returns
- true if there is user data on this key, false otherwise.
◆ ShowUserDataCount()
ulong HPS.GeometryKey.ShowUserDataCount |
( |
| ) |
|
|
inline |
Get the number of user data indices set on this key.
◆ ShowUserDataIndices()
bool HPS.GeometryKey.ShowUserDataIndices |
( |
out IntPtr [] |
out_indices | ) |
|
|
inline |
Shows the indices of all user data set on this key.
- Parameters
-
out_indices | The user data indices set on this key. |
- Returns
- The number of user data indices set on this key.
◆ UnsetAllUserData()
Removes all user data from this key.
- Returns
- A reference to this key.
◆ UnsetPriority()
Removes the drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetUserData() [1/2]
Removes the user data at the given index from this key.
- Parameters
-
in_index | The index of the user data to remove. |
- Returns
- A reference to this key.
◆ UnsetUserData() [2/2]
Removes the user data at the given indices from this key.
- Parameters
-
in_indices | The indices of the user data to remove. |
- Returns
- A reference to this key.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.GeometryKey.cs