Public Member Functions | Protected Member Functions | List of all members
HPS.CircularArcKey Class Reference

The CircularArcKey class is a smart pointer to a database object. It is handle to a circular arc inserted via SegmentKey::InsertCircularArc. A circular arc is the line geometry, as such its visualization will be determined by attributes affecting lines. More...

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

Public Member Functions

override void Dispose ()
 
 CircularArcKey ()
 The default constructor creates an uninitialized CircularArcKey object. The Type() function will return Type::None. More...
 
 CircularArcKey (HPS.Key in_that)
 This constructor creates a CircularArcKey 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 CircularArc key. Otherwise the copy will fail and the resulting CircularArcKey will be invalid. More...
 
 CircularArcKey (HPS.CircularArcKey in_that)
 This constructor creates a CircularArcKey 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 CircularArc key. Otherwise the copy will fail and the resulting CircularArcKey will be invalid. 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...
 
void Consume (HPS.CircularArcKit in_kit)
 Completely replaces all settings on this CircularArcKey with those set on the specified kit and resets the kit. More...
 
void Set (HPS.CircularArcKit in_kit)
 Replace those settings on this CircularArcKey with those set on the specified kit. More...
 
void Show (out HPS.CircularArcKit out_kit)
 Copy the contents of this CircularArcKey into the specified kit. More...
 
HPS.CircularArcKey SetStart (HPS.Point in_start)
 Sets the start point for this CircularArcKey. This is the point on the circumference of the circle at which the circular arc starts. More...
 
HPS.CircularArcKey SetMiddle (HPS.Point in_middle)
 Sets the middle point for this CircularArcKey. This is a point on the circumference of the circle between the start and end points for the circular arc. More...
 
HPS.CircularArcKey SetEnd (HPS.Point in_end)
 Sets the end point for this CircularArcKey. This is the point on the circumference of the circle at which the circular arc ends. More...
 
bool ShowStart (out HPS.Point out_start)
 Shows the start point for this CircularArcKey. More...
 
bool ShowMiddle (out HPS.Point out_middle)
 Shows the middle point for this CircularArcKey. More...
 
bool ShowEnd (out HPS.Point out_end)
 Shows the end point for this CircularArcKey. 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)
 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...
 
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...
 
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...
 
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 UnsetPriority ()
 Removes the drawing priority setting. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. 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...
 
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...
 
HPS.GeometryKey UnsetAllUserData ()
 Removes all user data from 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...
 
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...
 
bool ShowBoundings (out HPS.BoundingKit out_kit)
 Shows the bounding of this geometry. More...
 
- Public Member Functions inherited from HPS.Key
override void Dispose ()
 
 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...
 
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...
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

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

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

 
void Delete ()
 Removes the database object referred to by this key. 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...
 
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...
 
virtual void Assign (HPS.Key in_that)
 Share the smart-pointer. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 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...
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The CircularArcKey class is a smart pointer to a database object. It is handle to a circular arc inserted via SegmentKey::InsertCircularArc. A circular arc is the line geometry, as such its visualization will be determined by attributes affecting lines.

Constructor & Destructor Documentation

HPS.CircularArcKey.CircularArcKey ( )
inline

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

HPS.CircularArcKey.CircularArcKey ( HPS.Key  in_that)
inline

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

HPS.CircularArcKey.CircularArcKey ( HPS.CircularArcKey  in_that)
inline

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

Member Function Documentation

void HPS.CircularArcKey.Consume ( HPS.CircularArcKit  in_kit)
inline

Completely replaces all settings on this CircularArcKey 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 <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
override HPS.Type HPS.CircularArcKey.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.CircularArcKey.Set ( HPS.CircularArcKit  in_kit)
inline

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

Parameters
in_kitThe kit from which to get the settings to replace on this <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
HPS.CircularArcKey HPS.CircularArcKey.SetEnd ( HPS.Point  in_end)
inline

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

Parameters
in_endThe end point for this <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
Returns
A reference to this CircularArcKey.
HPS.CircularArcKey HPS.CircularArcKey.SetMiddle ( HPS.Point  in_middle)
inline

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

Parameters
in_middleThe middle point for this <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
Returns
A reference to this CircularArcKey.
HPS.CircularArcKey HPS.CircularArcKey.SetStart ( HPS.Point  in_start)
inline

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

Parameters
in_startThe start point for this <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
Returns
A reference to this CircularArcKey.
void HPS.CircularArcKey.Show ( out HPS.CircularArcKit  out_kit)
inline

Copy the contents of this CircularArcKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
bool HPS.CircularArcKey.ShowEnd ( out HPS.Point  out_end)
inline

Shows the end point for this CircularArcKey.

Parameters
out_endThe end point for this <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
Returns
true if an end point was set, false otherwise.
bool HPS.CircularArcKey.ShowMiddle ( out HPS.Point  out_middle)
inline

Shows the middle point for this CircularArcKey.

Parameters
out_middleThe middle point for this <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
Returns
true if a middle point was set, false otherwise.
bool HPS.CircularArcKey.ShowStart ( out HPS.Point  out_start)
inline

Shows the start point for this CircularArcKey.

Parameters
out_startThe start point for this <ref refid="class_h_p_s_1_1_circular_arc_key" kindref="compound">CircularArcKey</ref>.
Returns
true if a start point was set, false otherwise.

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