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

Public Member Functions

 CircularWedgeKey ()
 
 CircularWedgeKey (HPS.Key in_that)
 
 CircularWedgeKey (HPS.CircularWedgeKey in_that)
 
void Consume (HPS.CircularWedgeKit in_kit)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CircularWedgeKit in_kit)
 
HPS.CircularWedgeKey SetEnd (HPS.Point in_end)
 
HPS.CircularWedgeKey SetMiddle (HPS.Point in_middle)
 
HPS.CircularWedgeKey SetStart (HPS.Point in_start)
 
void Show (out HPS.CircularWedgeKit out_kit)
 
bool ShowEnd (out HPS.Point out_end)
 
bool ShowMiddle (out HPS.Point out_middle)
 
bool ShowStart (out HPS.Point out_start)
 
- 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 CircularWedgeKey class is a smart pointer to a database object. It is a handle to a circular wedge inserted via SegmentKey.InsertCircularWedge. A circular wedge has face geometry contained within the boundary edges of the circular wedge. The visualization of the wedge will be determined by attribute settings affecting faces and edges.

Constructor & Destructor Documentation

◆ CircularWedgeKey() [1/3]

HPS.CircularWedgeKey.CircularWedgeKey ( )
inline

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

◆ CircularWedgeKey() [2/3]

HPS.CircularWedgeKey.CircularWedgeKey ( HPS.Key  in_that)
inline

This constructor creates a CircularWedgeKey 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 CircularWedge key. Otherwise the copy will fail and the resulting CircularWedgeKey will be invalid.

◆ CircularWedgeKey() [3/3]

HPS.CircularWedgeKey.CircularWedgeKey ( HPS.CircularWedgeKey  in_that)
inline

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

Parameters
in_thatThe source CircularWedgeKey to copy.

Member Function Documentation

◆ Consume()

void HPS.CircularWedgeKey.Consume ( HPS.CircularWedgeKit  in_kit)
inline

Completely replaces all settings on this CircularWedgeKey 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 CircularWedgeKey.

◆ ObjectType()

override HPS.Type HPS.CircularWedgeKey.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.CircularWedgeKey.Set ( HPS.CircularWedgeKit  in_kit)
inline

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

Parameters
in_kitThe kit from which to get the settings to replace on this CircularWedgeKey.

◆ SetEnd()

HPS.CircularWedgeKey HPS.CircularWedgeKey.SetEnd ( HPS.Point  in_end)
inline

Sets the end point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge ends.

Parameters
in_endThe end point for this CircularWedgeKey.
Returns
A reference to this CircularWedgeKey.

◆ SetMiddle()

HPS.CircularWedgeKey HPS.CircularWedgeKey.SetMiddle ( HPS.Point  in_middle)
inline

Sets the middle point for this CircularWedgeKey. This is a point on the circumference of the circle between the start and end points for the circular wedge.

Parameters
in_middleThe middle point for this CircularWedgeKey.
Returns
A reference to this CircularWedgeKey.

◆ SetStart()

HPS.CircularWedgeKey HPS.CircularWedgeKey.SetStart ( HPS.Point  in_start)
inline

Sets the start point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge starts.

Parameters
in_startThe start point for this CircularWedgeKey.
Returns
A reference to this CircularWedgeKey.

◆ Show()

void HPS.CircularWedgeKey.Show ( out HPS.CircularWedgeKit  out_kit)
inline

Copy the contents of this CircularWedgeKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this CircularWedgeKey.

◆ ShowEnd()

bool HPS.CircularWedgeKey.ShowEnd ( out HPS.Point  out_end)
inline

Shows the end point for this CircularWedgeKey.

Parameters
out_endThe end point for this CircularWedgeKey.
Returns
true if an end point was set, false otherwise.

◆ ShowMiddle()

bool HPS.CircularWedgeKey.ShowMiddle ( out HPS.Point  out_middle)
inline

Shows the middle point for this CircularWedgeKey.

Parameters
out_middleThe middle point for this CircularWedgeKey.
Returns
true if a middle point was set, false otherwise.

◆ ShowStart()

bool HPS.CircularWedgeKey.ShowStart ( out HPS.Point  out_start)
inline

Shows the start point for this CircularWedgeKey.

Parameters
out_startThe start point for this CircularWedgeKey.
Returns
true if a start point was set, false otherwise.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.CircularWedgeKey.cs