API Search || Global Search

More...

Inheritance diagram for HPS.SphereAttributeKit:
HPS.Kit HPS.Object

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 ()
 
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...
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override 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...
 
- 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. 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...
 

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 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
 

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

HPS.SphereAttributeKit.SphereAttributeKit ( )
inline

Initializes an empty kit.

HPS.SphereAttributeKit.SphereAttributeKit ( HPS.SphereAttributeKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

override bool HPS.SphereAttributeKit.Empty ( )
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.

bool HPS.SphereAttributeKit.Equals ( HPS.SphereAttributeKit  in_kit)
inline

Check if the source SphereAttributeKit is equivalent to this object.

Parameters
in_kitThe source SphereAttributeKit to compare to this object.
Returns
    true if the objects are equivalent, false otherwise.
static HPS.SphereAttributeKit HPS.SphereAttributeKit.GetDefault ( )
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.
void HPS.SphereAttributeKit.Set ( HPS.SphereAttributeKit  in_kit)
inline

Copies all settings from the source SphereAttributeKit into this object.

Parameters
in_kitThe source SphereAttributeKit to copy.
HPS.SphereAttributeKit HPS.SphereAttributeKit.SetTessellation ( ulong  in_facets)
inline

Sets the number of faces that should be generated around the equator of spheres.

Parameters
in_facetsthe number of faces that should be generated around the equator of spheres.
Returns
    A reference to this object.
void HPS.SphereAttributeKit.Show ( out HPS.SphereAttributeKit  out_kit)
inline

Copies all settings from this SphereAttributeKit into the given SphereAttributeKit.

Parameters
out_kitThe SphereAttributeKit to populate with the contents of this object.
bool HPS.SphereAttributeKit.ShowTessellation ( out ulong  out_facets)
inline

Shows the number of faces that should be generated around the equator of spheres.

Parameters
out_facetsThe number of faces that should be generated around the equator of spheres.
Returns
    true if the setting is valid, false otherwise.
HPS.SphereAttributeKit HPS.SphereAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
    A reference to this object.
HPS.SphereAttributeKit HPS.SphereAttributeKit.UnsetTessellation ( )
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