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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SphereAttributeKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.SphereAttributeKit in_kit)
 
HPS.SphereAttributeKit SetTessellation (ulong in_facets)
 
void Show (out HPS.SphereAttributeKit out_kit)
 
bool ShowTessellation (out ulong out_facets)
 
 SphereAttributeKit ()
 
 SphereAttributeKit (HPS.SphereAttributeKit in_kit)
 
HPS.SphereAttributeKit UnsetEverything ()
 
HPS.SphereAttributeKit UnsetTessellation ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.SphereAttributeKit GetDefault ()
 
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

◆ SphereAttributeKit() [1/2]

HPS.SphereAttributeKit.SphereAttributeKit ( )
inline

Initializes an empty kit.

◆ SphereAttributeKit() [2/2]

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

◆ Empty()

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.

◆ Equals()

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.

◆ GetDefault()

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.

◆ ObjectType()

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

◆ Set()

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.

◆ SetTessellation()

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.

◆ Show()

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.

◆ ShowTessellation()

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.

◆ UnsetEverything()

HPS.SphereAttributeKit HPS.SphereAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetTessellation()

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