< Home

< Table of Contents

REFERENCE MANUAL

HPS.CircularArcKit Class Reference

The CircularArcKit class is a user space object. More...

Inheritance diagram for HPS.CircularArcKit:
HPS.Object

Public Member Functions

 CircularArcKit ()
 The default constructor creates an empty CircularArcKit object. More...
 
 CircularArcKit (HPS.CircularArcKit in_kit)
 The copy constructor creates a new CircularArcKit object that contains the same settings as the source CircularArcKit. More...
 
void Consume (HPS.CircularArcKit in_kit)
 Copies the source CircularArcKit into this CircularArcKit and resets the source kit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this CircularArcKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CircularArcKit in_kit)
 Check if the source CircularArcKit is equivalent to this CircularArcKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.CircularArcKit in_kit)
 Copies the source CircularArcKit into this CircularArcKit. More...
 
HPS.CircularArcKit SetEnd (HPS.Point in_end)
 Sets the end point for this CircularArcKit. More...
 
HPS.CircularArcKit SetMiddle (HPS.Point in_middle)
 Sets the middle point for this CircularArcKit. More...
 
HPS.CircularArcKit SetPriority (int in_priority)
 Assigns a specific drawing priority value to the CircularArcKit. More...
 
HPS.CircularArcKit SetStart (HPS.Point in_start)
 Sets the start point for this CircularArcKit. More...
 
HPS.CircularArcKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.CircularArcKit SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.CircularArcKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this kit. More...
 
void Show (out HPS.CircularArcKit out_kit)
 Copies this CircularArcKit into the given CircularArcKit. More...
 
bool ShowEnd (out HPS.Point out_end)
 Shows the end point for this CircularArcKit. More...
 
bool ShowMiddle (out HPS.Point out_middle)
 Shows the middle point for this CircularArcKit. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
bool ShowStart (out HPS.Point out_start)
 Shows the start point for this CircularArcKit. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this kit. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this kit. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this kit. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this kit. More...
 
HPS.CircularArcKit UnsetAllUserData ()
 Removes all user data from this kit. More...
 
HPS.CircularArcKit UnsetEnd ()
 Removes the end point for this CircularArcKit. More...
 
HPS.CircularArcKit UnsetEverything ()
 Removes all settings from the CircularArcKit. More...
 
HPS.CircularArcKit UnsetMiddle ()
 Removes the middle point for this CircularArcKit. More...
 
HPS.CircularArcKit UnsetPriority ()
 Removes a drawing priority setting. More...
 
HPS.CircularArcKit UnsetStart ()
 Removes the start point for this CircularArcKit. More...
 
HPS.CircularArcKit UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this kit. More...
 
HPS.CircularArcKit UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this kit. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 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...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static bool operator!= (HPS.CircularArcKit a, HPS.CircularArcKit b)
 
static bool operator== (HPS.CircularArcKit a, HPS.CircularArcKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The CircularArcKit class is a user space object.

It is a kit analog to a CircularArcKey.

Constructor & Destructor Documentation

HPS.CircularArcKit.CircularArcKit ( )

The default constructor creates an empty CircularArcKit object.

HPS.CircularArcKit.CircularArcKit ( HPS.CircularArcKit  in_kit)

The copy constructor creates a new CircularArcKit object that contains the same settings as the source CircularArcKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref> to copy.

Member Function Documentation

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

Copies the source CircularArcKit into this CircularArcKit and resets the source kit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to consume.
override bool HPS.CircularArcKit.Empty ( )
virtual

Indicates whether this CircularArcKit has any values set on it.

Returns
true if no values are set on this CircularArcKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.CircularArcKit.Equals ( HPS.CircularArcKit  in_kit)

Check if the source CircularArcKit is equivalent to this CircularArcKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref> to compare to this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.CircularArcKit.ObjectType ( )
virtual

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.CircularArcKit.Set ( HPS.CircularArcKit  in_kit)

Copies the source CircularArcKit into this CircularArcKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref> to copy.
HPS.CircularArcKit HPS.CircularArcKit.SetEnd ( HPS.Point  in_end)

Sets the end point for this CircularArcKit.

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_kit" kindref="compound">CircularArcKit</ref>.
Returns
A reference to this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.SetMiddle ( HPS.Point  in_middle)

Sets the middle point for this CircularArcKit.

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_kit" kindref="compound">CircularArcKit</ref>.
Returns
A reference to this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.SetPriority ( int  in_priority)

Assigns a specific drawing priority value to the CircularArcKit.

It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.

SubwindowKit::SetPriority()

SubwindowKit::SetRenderingAlgorithm()

HPS.CircularArcKit HPS.CircularArcKit.SetStart ( HPS.Point  in_start)

Sets the start point for this CircularArcKit.

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_kit" kindref="compound">CircularArcKit</ref>.
Returns
A reference to this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte[]  in_data 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.
HPS.CircularArcKit HPS.CircularArcKit.SetUserData ( IntPtr  in_index,
byte[]  in_data 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.
HPS.CircularArcKit HPS.CircularArcKit.SetUserData ( IntPtr[]  in_indices,
byte  in_data[][] 
)

Sets user data on this kit.

Parameters
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.
void HPS.CircularArcKit.Show ( out HPS.CircularArcKit  out_kit)

Copies this CircularArcKit into the given CircularArcKit.

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

Shows the end point for this CircularArcKit.

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

Shows the middle point for this CircularArcKit.

Parameters
out_middleThe middle point for this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>.
Returns
true if a middle point was set, false otherwise.
bool HPS.CircularArcKit.ShowPriority ( out int  out_priority)

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.
bool HPS.CircularArcKit.ShowStart ( out HPS.Point  out_start)

Shows the start point for this CircularArcKit.

Parameters
out_startThe start point for this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>.
Returns
true if a start point was set, false otherwise.
bool HPS.CircularArcKit.ShowUserData ( IntPtr  in_index,
out byte[]  out_data 
)

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.
bool HPS.CircularArcKit.ShowUserData ( out IntPtr[]  out_indices,
out byte  out_data[][] 
)

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
Returns
true if there is user data on this kit, false otherwise.
ulong HPS.CircularArcKit.ShowUserDataCount ( )

Get the number of user data indices set on this kit.

bool HPS.CircularArcKit.ShowUserDataIndices ( out IntPtr[]  out_indices)

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetEnd ( )

Removes the end point for this CircularArcKit.

Returns
A reference to this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetEverything ( )

Removes all settings from the CircularArcKit.

Returns
A reference to this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetMiddle ( )

Removes the middle point for this CircularArcKit.

Returns
A reference to this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.
HPS.CircularArcKit HPS.CircularArcKit.UnsetStart ( )

Removes the start point for this CircularArcKit.

Returns
A reference to this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetUserData ( IntPtr  in_index)

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetUserData ( IntPtr[]  in_indices)

Removes the user data at the given indices from this kit.

Parameters
in_countThe size of the following array.
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

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