Overview

Sample Code

Programming Guide

API Reference

Support

HPS.CircleKey Class Reference

The CircleKey class is a smart pointer to a database object. It is a handle to a circle inserted via SegmentKey::InsertCircle. A circle has face geometry contained within its circumference. The visualization of the circle will be determined by attribute settings affecting faces and edges. More...

Inheritance diagram for HPS.CircleKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

 CircleKey ()
 The default constructor creates an uninitialized CircleKey object. The Type() function will return Type::None. More...
 
 CircleKey (HPS.Key in_that)
 This constructor creates a CircleKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a Circle key. Otherwise the copy will fail and the resulting CircleKey will be invalid. More...
 
 CircleKey (HPS.CircleKey in_that)
 The copy constructor creates a CircleKey object that shares the underlying smart-pointer of the source CircleKey. More...
 
void Consume (HPS.CircleKit in_kit)
 Completely replaces all settings on this CircleKey with those set on the specified kit and resets the kit. More...
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.CircleKit in_kit)
 Replace those settings on this CircleKey with those set on the specified kit. More...
 
HPS.CircleKey SetCenter (HPS.Point in_center)
 Sets the center point for this CircleKey. More...
 
HPS.CircleKey SetNormal (HPS.Vector in_normal)
 Sets the normal for this CircleKey. This is the normal for the plane in which the circle lies. More...
 
HPS.CircleKey SetRadius (float in_radius)
 Sets the radius for this CircleKey. More...
 
void Show (out HPS.CircleKit out_kit)
 Copy the contents of this CircleKey into the specified kit. More...
 
bool ShowCenter (out HPS.Point out_center)
 Shows the center point for this CircleKey. More...
 
bool ShowNormal (out HPS.Vector out_normal)
 Shows the normal for this CircleKey. More...
 
bool ShowRadius (out float out_radius)
 Shows the radius for this CircleKey. More...
 
- Public Member Functions inherited from HPS.GeometryKey
override void Dispose ()
 
 GeometryKey ()
 The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type::None. More...
 
 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. More...
 
 GeometryKey (HPS.GeometryKey in_that)
 The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
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. 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 ShowBounding (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. Note that while a segment may only appear once in the returned array, that segment could have multiple 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 underlying smart-pointer of the Key source. 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. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) 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. This does not necessarily give the true type of the underlying object. 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. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.GeometryKey
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
 

Detailed Description

The CircleKey class is a smart pointer to a database object. It is a handle to a circle inserted via SegmentKey::InsertCircle. A circle has face geometry contained within its circumference. The visualization of the circle will be determined by attribute settings affecting faces and edges.

Constructor & Destructor Documentation

HPS.CircleKey.CircleKey ( )
inline

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

HPS.CircleKey.CircleKey ( HPS.Key  in_that)
inline

This constructor creates a CircleKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a Circle key. Otherwise the copy will fail and the resulting CircleKey will be invalid.

HPS.CircleKey.CircleKey ( HPS.CircleKey  in_that)
inline

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

Parameters
in_thatThe source CircleKey to copy.

Member Function Documentation

void HPS.CircleKey.Consume ( HPS.CircleKit  in_kit)
inline

Completely replaces all settings on this CircleKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this CircleKey.
override HPS.Type HPS.CircleKey.ObjectType ( )
inlinevirtual

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.

void HPS.CircleKey.Set ( HPS.CircleKit  in_kit)
inline

Replace those settings on this CircleKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this CircleKey.
HPS.CircleKey HPS.CircleKey.SetCenter ( HPS.Point  in_center)
inline

Sets the center point for this CircleKey.

Parameters
in_centerThe center point for this CircleKey.
Returns
A reference to this CircleKey.
HPS.CircleKey HPS.CircleKey.SetNormal ( HPS.Vector  in_normal)
inline

Sets the normal for this CircleKey. This is the normal for the plane in which the circle lies.

Parameters
in_normalThe normal for this CircleKey.
Returns
A reference to this CircleKey.
HPS.CircleKey HPS.CircleKey.SetRadius ( float  in_radius)
inline

Sets the radius for this CircleKey.

Parameters
in_radiusThe radius for this CircleKey.
Returns
A reference to this CircleKey.
void HPS.CircleKey.Show ( out HPS.CircleKit  out_kit)
inline

Copy the contents of this CircleKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this CircleKey.
bool HPS.CircleKey.ShowCenter ( out HPS.Point  out_center)
inline

Shows the center point for this CircleKey.

Parameters
out_centerThe center point for this CircleKey.
Returns
true if a center point was set, false otherwise.
bool HPS.CircleKey.ShowNormal ( out HPS.Vector  out_normal)
inline

Shows the normal for this CircleKey.

Parameters
out_normalThe normal for this CircleKey.
Returns
true if a normal was set, false otherwise.
bool HPS.CircleKey.ShowRadius ( out float  out_radius)
inline

Shows the radius for this CircleKey.

Parameters
out_radiusThe radius for this CircleKey.
Returns
true if a radius was set, false otherwise.

The documentation for this class was generated from the following file: