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

Public Member Functions

void Consume (HPS.EllipticalArcKit in_kit)
 
override void Dispose ()
 
 EllipticalArcKey ()
 
 EllipticalArcKey (HPS.Key in_that)
 
 EllipticalArcKey (HPS.EllipticalArcKey in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.EllipticalArcKit in_kit)
 
HPS.EllipticalArcKey SetCenter (HPS.Point in_center)
 
HPS.EllipticalArcKey SetEnd (float in_end)
 
HPS.EllipticalArcKey SetMajor (HPS.Point in_major)
 
HPS.EllipticalArcKey SetMinor (HPS.Point in_minor)
 
HPS.EllipticalArcKey SetStart (float in_start)
 
void Show (out HPS.EllipticalArcKit out_kit)
 
bool ShowCenter (out HPS.Point out_center)
 
bool ShowEnd (out float out_end)
 
bool ShowMajor (out HPS.Point out_major)
 
bool ShowMinor (out HPS.Point out_minor)
 
bool ShowStart (out float 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 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

◆ EllipticalArcKey() [1/3]

HPS.EllipticalArcKey.EllipticalArcKey ( )
inline

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

◆ EllipticalArcKey() [2/3]

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.

◆ EllipticalArcKey() [3/3]

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

◆ Consume()

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.

◆ ObjectType()

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

◆ SetCenter()

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.

◆ SetEnd()

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.

◆ SetMajor()

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.

◆ SetMinor()

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.

◆ SetStart()

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.

◆ Show()

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.

◆ ShowCenter()

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.

◆ ShowEnd()

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.

◆ ShowMajor()

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.

◆ ShowMinor()

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.

◆ ShowStart()

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