The HPS::SphereAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::SphereAttributeKit::GetDefault() will return a kit with values found in this table. More...

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SphereAttributeKit in_kit) |
Check if the source SphereAttributeKit is equivalent to this object. 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.SphereAttributeKit in_kit) |
Copies all settings from the source SphereAttributeKit into this object. More... | |
HPS.SphereAttributeKit | SetTessellation (ulong in_facets) |
Sets the number of faces that should be generated around the equator of spheres. More... | |
void | Show (out HPS.SphereAttributeKit out_kit) |
Copies all settings from this SphereAttributeKit into the given SphereAttributeKit. More... | |
bool | ShowTessellation (out ulong out_facets) |
Shows the number of faces that should be generated around the equator of spheres. More... | |
SphereAttributeKit () | |
Initializes an empty kit. More... | |
SphereAttributeKit (HPS.SphereAttributeKit in_kit) | |
The copy constructor creates a new SphereAttributeKit object that contains the same settings as the source object. More... | |
HPS.SphereAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.SphereAttributeKit | UnsetTessellation () |
Removes the sphere tessellation setting. 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 HPS.SphereAttributeKit | GetDefault () |
Creates a SphereAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. More... | |
static bool | operator!= (HPS.SphereAttributeKit a, HPS.SphereAttributeKit b) |
static bool | operator== (HPS.SphereAttributeKit a, HPS.SphereAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS::SphereAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::SphereAttributeKit::GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new SphereAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source SphereAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source SphereAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates a SphereAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A SphereAttributeKit with the default settings.
|
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 |
Copies all settings from the source SphereAttributeKit into this object.
- Parameters
-
in_kit The source SphereAttributeKit to copy.
|
inline |
Sets the number of faces that should be generated around the equator of spheres.
- Parameters
-
in_facets the number of faces that should be generated around the equator of spheres.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this SphereAttributeKit into the given SphereAttributeKit.
- Parameters
-
out_kit The SphereAttributeKit to populate with the contents of this object.
|
inline |
Shows the number of faces that should be generated around the equator of spheres.
- Parameters
-
out_facets The number of faces that should be generated around the equator of spheres.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the sphere tessellation setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SphereAttributeKit.cs