GeometryKey

class HPS.GeometryKey : public HPS.Key 

Subclassed by 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 Functions

override void Dispose ()

GeometryKey (): The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type.None.

GeometryKey (HPS.GeometryKey in_that)

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

Param in_that: The source GeometryKey to copy.

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.

Param in_that: The source Key to copy.

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

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.

See: SubwindowKit.SetRenderingAlgorithm()

Param in_priority: The drawing priority; higher priority items are drawn on top of lower priority items.
Return: A reference to this object.

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

Sets user data on this key.

Param in_index: The index of the user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this key.

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

Sets user data on this key.

Param in_index: The index of the user data to set.
Param in_bytes: The number of bytes of user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this key.

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

Sets user data on this key.

Param in_indices: An array of user data indices to set.
Param in_data: An array of bytes of user data to set.
Return: A reference to this key.

bool ShowBounding (out HPS.BoundingKit out_kit)

Shows the bounding of this geometry.

Param out_kit: The BoundingKit that is set on this GeometryKey
Return: False if no bounding exists.

bool ShowPriority (out int out_priority)

Shows the drawing priority.

Param out_priority: The drawing priority; higher priority items are drawn on top of lower priority items.
Return: true if a priority was specified, false otherwise.

ulong ShowReferrers (out HPS.ReferenceKey[] out_references)

Shows the all the references to this key.

Param out_references: The list of all references to this key.
Return: The number of references to this key.

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.

Param out_segments: The list of segments which contains references to this key.
Return: The number of segments which contain references to this key.

bool ShowUserData (IntPtr in_index, out byte[] out_data)

Shows the user data at a given index for this key.

Param in_index: The index of the user data to show.
Param out_data: The user data at the given index.
Return: true if there is user data at the given index, false otherwise.

bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)

Shows all user data for this key.

Param out_indices: An array of all user data indices set on this key.
Param out_data: An array of all user data set on this key.
Return: true if there is user data on this key, false otherwise.

ulong ShowUserDataCount (): Get the number of user data indices set on this key.

bool ShowUserDataIndices (out IntPtr[] out_indices)

Shows the indices of all user data set on this key.

Param out_indices: The user data indices set on this key.
Return: The number of user data indices set on this key.

HPS.GeometryKey UnsetAllUserData ()

Removes all user data from this key.

Return: A reference to this key.

HPS.GeometryKey UnsetPriority ()

Removes the drawing priority setting.

Return: A reference to this object.

HPS.GeometryKey UnsetUserData (IntPtr in_index)

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

Param in_index: The index of the user data to remove.
Return: A reference to this key.

HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)

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

Param in_indices: The indices of the user data to remove.
Return: A reference to this key.