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

The EllipseKey class is a smart pointer to a database object. It is a handle to an ellipse inserted via SegmentKey::InsertEllipse. More...

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

Public Member Functions

override void Dispose ()
 
 EllipseKey ()
 The default constructor creates an uninitialized EllipseKey object. The Type() function will return Type::None. More...
 
 EllipseKey (HPS.Key in_that)
 This constructor creates an EllipseKey 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 an Ellipse key. Otherwise the copy will fail and the resulting EllipseKey will be invalid. More...
 
 EllipseKey (HPS.EllipseKey in_that)
 This constructor creates an EllipseKey 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 an Ellipse key. Otherwise the copy will fail and the resulting EllipseKey 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.EllipseKit in_kit)
 Completely replaces all settings on this EllipseKit with those set on the specified kit and resets the kit. More...
 
void Set (HPS.EllipseKit in_kit)
 Replace those settings on this EllipseKey with those set on the specified kit. More...
 
void Show (out HPS.EllipseKit out_kit)
 Copy the contents of this EllipseKey into the specified kit. More...
 
HPS.EllipseKey SetCenter (HPS.Point in_center)
 Sets the center point for the ellipse. More...
 
HPS.EllipseKey SetMajor (HPS.Point in_major)
 Sets the intersection point of the major axis and the ellipse. More...
 
HPS.EllipseKey SetMinor (HPS.Point in_minor)
 Sets the intersection point of the minor axis and the ellipse. More...
 
bool ShowCenter (out HPS.Point out_center)
 Shows the center point for the ellipse. More...
 
bool ShowMajor (out HPS.Point out_major)
 Shows the intersection point of the major axis and the ellipse. More...
 
bool ShowMinor (out HPS.Point out_minor)
 Shows the intersection point of the minor axis and the ellipse. 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 EllipseKey class is a smart pointer to a database object. It is a handle to an ellipse inserted via SegmentKey::InsertEllipse.

Constructor & Destructor Documentation

HPS.EllipseKey.EllipseKey ( )
inline

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

HPS.EllipseKey.EllipseKey ( HPS.Key  in_that)
inline

This constructor creates an EllipseKey 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 an Ellipse key. Otherwise the copy will fail and the resulting EllipseKey will be invalid.

HPS.EllipseKey.EllipseKey ( HPS.EllipseKey  in_that)
inline

This constructor creates an EllipseKey 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 an Ellipse key. Otherwise the copy will fail and the resulting EllipseKey will be invalid.

Member Function Documentation

void HPS.EllipseKey.Consume ( HPS.EllipseKit  in_kit)
inline

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

Replace those settings on this EllipseKey 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_ellipse_key" kindref="compound">EllipseKey</ref>.
HPS.EllipseKey HPS.EllipseKey.SetCenter ( HPS.Point  in_center)
inline

Sets the center point for the ellipse.

Parameters
in_centerThe center point for the ellipse.
Returns
A reference to this EllipseKey.
HPS.EllipseKey HPS.EllipseKey.SetMajor ( HPS.Point  in_major)
inline

Sets the intersection point of the major axis and the ellipse.

Parameters
in_majorThe intersection point of the major axis and the ellipse.
Returns
A reference to this EllipseKey.
HPS.EllipseKey HPS.EllipseKey.SetMinor ( HPS.Point  in_minor)
inline

Sets the intersection point of the minor axis and the ellipse.

Parameters
in_minorThe intersection point of the minor axis and the ellipse.
Returns
A reference to this EllipseKey.
void HPS.EllipseKey.Show ( out HPS.EllipseKit  out_kit)
inline

Copy the contents of this EllipseKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this <ref refid="class_h_p_s_1_1_ellipse_key" kindref="compound">EllipseKey</ref>.
bool HPS.EllipseKey.ShowCenter ( out HPS.Point  out_center)
inline

Shows the center point for the ellipse.

Parameters
out_centerThe center point for the ellipse.
Returns
true if a center was set, false otherwise.
bool HPS.EllipseKey.ShowMajor ( out HPS.Point  out_major)
inline

Shows the intersection point of the major axis and the ellipse.

Parameters
out_majorThe intersection point of the major axis and the ellipse.
Returns
true if an intersection point with the major axis was set, false otherwise.
bool HPS.EllipseKey.ShowMinor ( out HPS.Point  out_minor)
inline

Shows the intersection point of the minor axis and the ellipse.

Parameters
out_minorThe intersection point of the minor axis and the ellipse.
Returns
true if an intersection point with the minor axis was set, false otherwise.

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