< Home

< Table of Contents

REFERENCE MANUAL

HPS.GeometryKey Class Reference
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 ()
 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...
 
- Public Member Functions inherited from HPS.Key
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 ()
 
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 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 ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
- Public Member Functions inherited from HPS.Object
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 ()
 
- 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
 
HandleRef scptr
 

Constructor & Destructor Documentation

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.

Member Function Documentation

override HPS.Type HPS.GeometryKey.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying 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.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.

Parameters
in_priorityThe drawing priority; higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.

SubwindowKit::SetRenderingAlgorithm()

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

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.
HPS.GeometryKey HPS.GeometryKey.SetUserData ( IntPtr  in_index,
byte[]  in_data 
)

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.
HPS.GeometryKey HPS.GeometryKey.SetUserData ( IntPtr[]  in_indices,
byte  in_data[][] 
)

Sets user data on this key.

Parameters
in_dataAn array of bytes of user data to set.
Returns
A reference to this key.
bool HPS.GeometryKey.ShowBoundings ( out HPS.BoundingKit  out_kit)

Shows the bounding of this geometry.

Returns
False if no bounding exists.
bool HPS.GeometryKey.ShowPriority ( out int  out_priority)

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

Parameters
out_segmentsThe list of segments which contains references to this key.
Returns
The number of segments which contain references to this key.
ulong HPS.GeometryKey.ShowReferrers ( out HPS.ReferenceKey[]  out_references)

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.
bool HPS.GeometryKey.ShowUserData ( IntPtr  in_index,
out byte[]  out_data 
)

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.
bool HPS.GeometryKey.ShowUserData ( out IntPtr[]  out_indices,
out byte  out_data[][] 
)

Shows all user data for this key.

Parameters
out_indicesAn array of all user data indices set on this key.
Returns
true if there is user data on this key, false otherwise.
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.

Parameters
out_indicesThe user data indices set on this key.
Returns
The number of user data indices set on this key.
HPS.GeometryKey HPS.GeometryKey.UnsetAllUserData ( )

Removes all user data from this key.

Returns
A reference to this key.
HPS.GeometryKey HPS.GeometryKey.UnsetPriority ( )

Removes the drawing priority setting.

Returns
A reference to this object.
HPS.GeometryKey HPS.GeometryKey.UnsetUserData ( IntPtr  in_index)

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.
HPS.GeometryKey HPS.GeometryKey.UnsetUserData ( IntPtr[]  in_indices)

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

Parameters
in_countThe size of the following array.
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: