The HPS::CircleKit class is a user space object. It is a kit analog to a HPS::CircleKey. More...

Public Member Functions | |
CircleKit () | |
The default constructor creates an empty CircleKit object. More... | |
CircleKit (HPS.CircleKit in_kit) | |
The copy constructor creates a new CircleKit object that contains the same settings as the source CircleKit. More... | |
void | Consume (HPS.CircleKit in_kit) |
Copies the source CircleKit into this CircleKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this CircleKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CircleKit in_kit) |
Check if the source CircleKit is equivalent to this CircleKit. More... | |
override int | GetHashCode () |
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 | Set (HPS.CircleKit in_kit) |
Copies the source CircleKit into this CircleKit. More... | |
HPS.CircleKit | SetCenter (HPS.Point in_center) |
Sets the center point for this CircleKit. More... | |
HPS.CircleKit | SetNormal (HPS.Vector in_normal) |
Sets the normal for this CircleKit. This is the normal for the plane in which the circle lies. More... | |
HPS.CircleKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the CircleKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority. More... | |
HPS.CircleKit | SetRadius (float in_radius) |
Sets the radius for this CircleKit. More... | |
HPS.CircleKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CircleKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CircleKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.CircleKit out_kit) |
Copies this CircleKit into the given CircleKit. More... | |
bool | ShowCenter (out HPS.Point out_center) |
Shows the center point for this CircleKit. More... | |
bool | ShowNormal (out HPS.Vector out_normal) |
Shows the normal for this CircleKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
bool | ShowRadius (out float out_radius) |
Shows the radius for this CircleKit. 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.CircleKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.CircleKit | UnsetCenter () |
Removes the center point for this CircleKit. More... | |
HPS.CircleKit | UnsetEverything () |
Removes all settings from the CircleKit. More... | |
HPS.CircleKit | UnsetNormal () |
Removes the normal for this CircleKit. More... | |
HPS.CircleKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.CircleKit | UnsetRadius () |
Removes the radius for this CircleKit. More... | |
HPS.CircleKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.CircleKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. 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... | |
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... | |
Static Public Member Functions | |
static bool | operator!= (HPS.CircleKit a, HPS.CircleKit b) |
static bool | operator== (HPS.CircleKit a, HPS.CircleKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
Detailed Description
The HPS::CircleKit class is a user space object. It is a kit analog to a HPS::CircleKey.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty CircleKit object.
|
inline |
Member Function Documentation
|
inline |
|
inlinevirtual |
Indicates whether this CircleKit has any values set on it.
- Returns
- true if no values are set on this CircleKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
|
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.
|
inline |
|
inline |
|
inline |
|
inline |
Assigns a specific drawing priority value to the CircleKit. 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_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- A reference to this object.
SubwindowKit::SetPriority()
|
inline |
|
inline |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_bytes The number of bytes of user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
Sets user data on this kit.
- Parameters
-
in_indices An array of user data indices to set. in_data An array of bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
|
inline |
|
inline |
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
|
inline |
Shows the user data at a given index for this kit.
- Parameters
-
in_index The index of the user data to show. out_data The user data at the given index.
- Returns
- true if there is user data at the given index, false otherwise.
|
inline |
Shows all user data for this kit.
- Parameters
-
out_indices An array of all user data indices set on this kit. out_data An array of all user data set on this kit.
- Returns
- true if there is user data on this kit, false otherwise.
|
inline |
Get the number of user data indices set on this kit.
|
inline |
Shows the indices of all user data set on this kit.
- Parameters
-
out_indices The user data indices set on this kit.
- Returns
- The number of user data indices set on this kit.
|
inline |
Removes all user data from this kit.
- Returns
- A reference to this kit.
|
inline |
|
inline |
|
inline |
|
inline |
Removes a drawing priority setting.
- Returns
- A reference to this object.
|
inline |
|
inline |
Removes the user data at the given index from this kit.
- Parameters
-
in_index The index of the user data to remove.
- Returns
- A reference to this kit.
|
inline |
Removes the user data at the given indices from this kit.
- Parameters
-
in_indices The indices of the user data to remove.
- Returns
- A reference to this kit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.CircleKit.cs