Inheritance diagram for HPS.GeometryKey:
HPS.Key HPS.Object HPS.CircleKey HPS.CircularArcKey HPS.CircularWedgeKey HPS.CuttingSectionKey HPS.CylinderKey HPS.DistantLightKey HPS.EllipseKey HPS.EllipticalArcKey HPS.GridKey HPS.InfiniteLineKey HPS.LineKey HPS.MarkerKey HPS.MeshKey HPS.NURBSCurveKey HPS.NURBSSurfaceKey HPS.PolygonKey HPS.ReferenceKey HPS.ShellKey HPS.SphereKey HPS.SpotlightKey HPS.TextKey

Public Member Functions

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

Constructor & Destructor Documentation

◆ 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_thatThe source Key to copy.

◆ GeometryKey() [3/3]

HPS.GeometryKey.GeometryKey ( HPS.GeometryKey  in_that)
inline

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

Parameters
in_thatThe source GeometryKey to copy.

Member Function Documentation

◆ 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()

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

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_priorityThe 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_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 key.

◆ SetUserData() [2/3]

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

Sets user data on this key.

Parameters
in_indexThe index of the user data to set.
in_dataThe 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_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this key.

◆ ShowBounding()

bool HPS.GeometryKey.ShowBounding ( out HPS.BoundingKit  out_kit)
inline

Shows the bounding of this geometry.

Parameters
out_kitThe BoundingKit that is set on this GeometryKey
Returns
False if no bounding exists.

◆ ShowPriority()

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

Shows the drawing priority.

Parameters
out_priorityThe 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_segmentsThe list of segments which contains references to this key.
Returns
The number of segments which contain references to this key.

◆ ShowReferrers() [2/2]

ulong HPS.GeometryKey.ShowReferrers ( out HPS.ReferenceKey []  out_references)
inline

Shows the all the references to this key.

Parameters
out_referencesThe 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_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.GeometryKey.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this key.

Parameters
out_indicesAn array of all user data indices set on this key.
out_dataAn 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_indicesThe user data indices set on this key.
Returns
The number of user data indices set on this key.

◆ UnsetAllUserData()

HPS.GeometryKey HPS.GeometryKey.UnsetAllUserData ( )
inline

Removes all user data from this key.

Returns
A reference to this key.

◆ UnsetPriority()

HPS.GeometryKey HPS.GeometryKey.UnsetPriority ( )
inline

Removes the drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/2]

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

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

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

◆ UnsetUserData() [2/2]

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

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

Parameters
in_indicesThe 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