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

Public Member Functions

 CylinderAttributeKit ()
 
 CylinderAttributeKit (HPS.CylinderAttributeKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CylinderAttributeKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CylinderAttributeKit in_kit)
 
HPS.CylinderAttributeKit SetOrientation (HPS.Cylinder.Orientation in_adjust)
 
HPS.CylinderAttributeKit SetTessellation (ulong in_facets)
 
void Show (out HPS.CylinderAttributeKit out_kit)
 
bool ShowOrientation (out HPS.Cylinder.Orientation out_orientation)
 
bool ShowTessellation (out ulong out_facets)
 
HPS.CylinderAttributeKit UnsetEverything ()
 
HPS.CylinderAttributeKit UnsetOrientation ()
 
HPS.CylinderAttributeKit UnsetTessellation ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
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.CylinderAttributeKit GetDefault ()
 
static bool operator!= (HPS.CylinderAttributeKit a, HPS.CylinderAttributeKit b)
 
static bool operator== (HPS.CylinderAttributeKit a, HPS.CylinderAttributeKit 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.Kit
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.CylinderAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.CylinderAttributeKit.GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ CylinderAttributeKit() [1/2]

HPS.CylinderAttributeKit.CylinderAttributeKit ( )
inline

Initializes an empty kit.

◆ CylinderAttributeKit() [2/2]

HPS.CylinderAttributeKit.CylinderAttributeKit ( HPS.CylinderAttributeKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.CylinderAttributeKit.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.CylinderAttributeKit.Equals ( HPS.CylinderAttributeKit  in_kit)
inline

Check if the source CylinderAttributeKit is equivalent to this object.

Parameters
in_kitThe source CylinderAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.CylinderAttributeKit HPS.CylinderAttributeKit.GetDefault ( )
inlinestatic

Creates a CylinderAttributeKit 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 CylinderAttributeKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.CylinderAttributeKit.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.Object.

◆ Set()

void HPS.CylinderAttributeKit.Set ( HPS.CylinderAttributeKit  in_kit)
inline

Copies all settings from the source CylinderAttributeKit into this object.

Parameters
in_kitThe source CylinderAttributeKit to copy.

◆ SetOrientation()

HPS.CylinderAttributeKit HPS.CylinderAttributeKit.SetOrientation ( HPS.Cylinder.Orientation  in_adjust)
inline

Sets the orientation of colors and radii of cylinders. This can be used to invert the order of the radii and/or colors of all cylinders in a segment without editing each one.

Returns
A reference to this object.

◆ SetTessellation()

HPS.CylinderAttributeKit HPS.CylinderAttributeKit.SetTessellation ( ulong  in_facets)
inline

Sets the number of faces that should be generated around cylinders.

Parameters
in_facetsthe number of faces that should be generated around cylinders.
Returns
A reference to this object.

◆ Show()

void HPS.CylinderAttributeKit.Show ( out HPS.CylinderAttributeKit  out_kit)
inline

Copies all settings from this CylinderAttributeKit into the given CylinderAttributeKit.

Parameters
out_kitThe CylinderAttributeKit to populate with the contents of this object.

◆ ShowOrientation()

bool HPS.CylinderAttributeKit.ShowOrientation ( out HPS.Cylinder.Orientation  out_orientation)
inline

Shows the orientation of colors and radii of cylinders.

Parameters
out_orientationThe orientation of colors and radii of cylinders.
Returns
true if the setting is valid, false otherwise.

◆ ShowTessellation()

bool HPS.CylinderAttributeKit.ShowTessellation ( out ulong  out_facets)
inline

Shows the number of faces that should be generated around cylinders.

Parameters
out_facetsThe number of faces that should be generated around cylinders
Returns
true if the setting is valid, false otherwise.

◆ UnsetEverything()

HPS.CylinderAttributeKit HPS.CylinderAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetOrientation()

HPS.CylinderAttributeKit HPS.CylinderAttributeKit.UnsetOrientation ( )
inline

Removes the cylinder orientation setting.

Returns
A reference to this object.

◆ UnsetTessellation()

HPS.CylinderAttributeKit HPS.CylinderAttributeKit.UnsetTessellation ( )
inline

Removes the cylinder 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.CylinderAttributeKit.cs