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

Public Member Functions

 CircleKey ()
 
 CircleKey (HPS.Key in_that)
 
 CircleKey (HPS.CircleKey in_that)
 
void Consume (HPS.CircleKit in_kit)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CircleKit in_kit)
 
HPS.CircleKey SetCenter (HPS.Point in_center)
 
HPS.CircleKey SetNormal (HPS.Vector in_normal)
 
HPS.CircleKey SetRadius (float in_radius)
 
void Show (out HPS.CircleKit out_kit)
 
bool ShowCenter (out HPS.Point out_center)
 
bool ShowNormal (out HPS.Vector out_normal)
 
bool ShowRadius (out float out_radius)
 
- Public Member Functions inherited from HPS.GeometryKey
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.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
 

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

◆ CircleKey() [1/3]

HPS.CircleKey.CircleKey ( )
inline

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

◆ CircleKey() [2/3]

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.

◆ CircleKey() [3/3]

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

◆ Consume()

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.

◆ ObjectType()

override HPS.Type HPS.CircleKey.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.

◆ Set()

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.

◆ SetCenter()

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.

◆ SetNormal()

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.

◆ SetRadius()

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.

◆ Show()

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.

◆ ShowCenter()

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.

◆ ShowNormal()

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.

◆ ShowRadius()

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:
  • internals/hps_core/source/cs/HPS.CircleKey.cs