API Search || Global Search

More...

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

Public Member Functions

void Consume (HPS.EllipticalArcKit in_kit)
 Completely replaces all settings on this EllipticalArcKey with those set on the specified kit and resets the kit. More...
 
override void Dispose ()
 
 EllipticalArcKey ()
 The default constructor creates an uninitialized EllipticalArcKey object. The Type() function will return Type.None. More...
 
 EllipticalArcKey (HPS.Key in_that)
 This constructor creates an EllipticalArcKey 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 EllipticalArc key. Otherwise the copy will fail and the resulting EllipticalArcKey will be invalid. More...
 
 EllipticalArcKey (HPS.EllipticalArcKey in_that)
 The copy constructor creates an EllipticalArcKey object that shares the underlying smart-pointer of the source EllipticalArcKey. More...
 
override HPS.Type ObjectType ()
 
void Set (HPS.EllipticalArcKit in_kit)
 Replace those settings on this EllipticalArcKey with those set on the specified kit. More...
 
HPS.EllipticalArcKey SetCenter (HPS.Point in_center)
 Sets the center point for the ellipse used to define the elliptcal arc. More...
 
HPS.EllipticalArcKey SetEnd (float in_end)
 Sets the normalized parametric value on the ellipse at which the elliptical arc ends. The value should be in the range [0.0f,1.0f] and be larger than the start value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f. More...
 
HPS.EllipticalArcKey SetMajor (HPS.Point in_major)
 Sets the intersection point of the major axis and the ellipse used to define the elliptcal arc. More...
 
HPS.EllipticalArcKey SetMinor (HPS.Point in_minor)
 Sets the intersection point of the minor axis and the ellipse used to define the elliptcal arc. More...
 
HPS.EllipticalArcKey SetStart (float in_start)
 Sets the normalized parametric value on the ellipse at which the elliptical arc starts. The value should be in the range [0.0f,1.0f] and be smaller than the end value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f. More...
 
void Show (out HPS.EllipticalArcKit out_kit)
 Copy the contents of this EllipticalArcKey into the specified kit. More...
 
bool ShowCenter (out HPS.Point out_center)
 Shows the center point for the ellipse used to define the elliptical arc. More...
 
bool ShowEnd (out float out_end)
 Shows the normalized parametric value on the ellipse at which the elliptical arc ends. More...
 
bool ShowMajor (out HPS.Point out_major)
 Shows the intersection point of the major axis and the ellipse used to define the elliptcal arc. More...
 
bool ShowMinor (out HPS.Point out_minor)
 Shows the intersection point of the minor axis and the ellipse used to define the elliptcal arc. More...
 
bool ShowStart (out float out_start)
 Shows the normalized parametric value on the ellipse at which the elliptical arc starts. 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 ()
 
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 associated 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 ()
 
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...
 
virtual 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
 

Detailed Description

The EllipticalArcKey class is a smart pointer to a database object. It is a handle to an elliptical arc inserted via SegmentKey.InsertEllipticalArc.

Constructor & Destructor Documentation

HPS.EllipticalArcKey.EllipticalArcKey ( )
inline

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

HPS.EllipticalArcKey.EllipticalArcKey ( HPS.Key  in_that)
inline

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

HPS.EllipticalArcKey.EllipticalArcKey ( HPS.EllipticalArcKey  in_that)
inline

The copy constructor creates an EllipticalArcKey object that shares the underlying smart-pointer of the source EllipticalArcKey.

Parameters
in_thatThe source EllipticalArcKey to copy.

Member Function Documentation

void HPS.EllipticalArcKey.Consume ( HPS.EllipticalArcKit  in_kit)
inline

Completely replaces all settings on this EllipticalArcKey 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 EllipticalArcKey.
void HPS.EllipticalArcKey.Set ( HPS.EllipticalArcKit  in_kit)
inline

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

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

Sets the center point for the ellipse used to define the elliptcal arc.

Parameters
in_centerThe center point for the ellipse used to define the elliptical arc.
Returns
    A reference to this EllipticalArcKey.
HPS.EllipticalArcKey HPS.EllipticalArcKey.SetEnd ( float  in_end)
inline

Sets the normalized parametric value on the ellipse at which the elliptical arc ends. The value should be in the range [0.0f,1.0f] and be larger than the start value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.

Parameters
in_endThe noramlized parametric value on the ellipse at which the elliptical arc ends. This value should be in the range [0.0f,1.0f] and be larger than the start value.
Returns
    A reference to this EllipticalArcKey.
HPS.EllipticalArcKey HPS.EllipticalArcKey.SetMajor ( HPS.Point  in_major)
inline

Sets the intersection point of the major axis and the ellipse used to define the elliptcal arc.

Parameters
in_majorThe intersection point of the major axis and the ellipse used to define the elliptical arc.
Returns
    A reference to this EllipticalArcKey.
HPS.EllipticalArcKey HPS.EllipticalArcKey.SetMinor ( HPS.Point  in_minor)
inline

Sets the intersection point of the minor axis and the ellipse used to define the elliptcal arc.

Parameters
in_minorThe intersection point of the minor axis and the ellipse used to define the elliptical arc.
Returns
    A reference to this EllipticalArcKey.
HPS.EllipticalArcKey HPS.EllipticalArcKey.SetStart ( float  in_start)
inline

Sets the normalized parametric value on the ellipse at which the elliptical arc starts. The value should be in the range [0.0f,1.0f] and be smaller than the end value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.

Parameters
in_startThe noramlized parametric value on the ellipse at which the elliptical arc starts. This value should be in the range [0.0f,1.0f] and be smaller than the end value.
Returns
    A reference to this EllipticalArcKey.
void HPS.EllipticalArcKey.Show ( out HPS.EllipticalArcKit  out_kit)
inline

Copy the contents of this EllipticalArcKey into the specified kit.

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

Shows the center point for the ellipse used to define the elliptical arc.

Parameters
out_centerThe center point for the ellipse used to define the elliptical arc.
Returns
    true if a center was set, false otherwise.
bool HPS.EllipticalArcKey.ShowEnd ( out float  out_end)
inline

Shows the normalized parametric value on the ellipse at which the elliptical arc ends.

Parameters
out_endThe noramlized parametric value on the ellipse at which the elliptical arc ends.
Returns
    true if a normalized parametric end value was set, false otherwise.
bool HPS.EllipticalArcKey.ShowMajor ( out HPS.Point  out_major)
inline

Shows the intersection point of the major axis and the ellipse used to define the elliptcal arc.

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

Shows the intersection point of the minor axis and the ellipse used to define the elliptcal arc.

Parameters
out_minorThe intersection point of the minor axis and the ellipse used to define the elliptical arc.
Returns
    true if an intersection point with the minor axis was set, false otherwise.
bool HPS.EllipticalArcKey.ShowStart ( out float  out_start)
inline

Shows the normalized parametric value on the ellipse at which the elliptical arc starts.

Parameters
out_startThe noramlized parametric value on the ellipse at which the elliptical arc starts.
Returns
    true if a normalized parametric start value was set, false otherwise.

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