HPS.CylinderAttributeControl Class Reference
Inheritance diagram for HPS.CylinderAttributeControl:
HPS.Control HPS.Object

Public Member Functions

 CylinderAttributeControl (HPS.SegmentKey in_seg)
 
 CylinderAttributeControl (HPS.CylinderAttributeControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.CylinderAttributeControl SetOrientation (HPS.Cylinder.Orientation in_orientation)
 
HPS.CylinderAttributeControl SetTessellation (ulong in_facets)
 
bool ShowOrientation (out HPS.Cylinder.Orientation out_adjust)
 
bool ShowTessellation (out ulong out_facets)
 
override HPS.Type Type ()
 
HPS.CylinderAttributeControl UnsetEverything ()
 
HPS.CylinderAttributeControl UnsetOrientation ()
 
HPS.CylinderAttributeControl UnsetTessellation ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.CylinderAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various cylinder attributes, such as orientation and tessellation. This table lists default values for the various segment attributes accessible from HPS.CylinderAttributeControl.

Constructor & Destructor Documentation

◆ CylinderAttributeControl() [1/2]

HPS.CylinderAttributeControl.CylinderAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ CylinderAttributeControl() [2/2]

HPS.CylinderAttributeControl.CylinderAttributeControl ( HPS.CylinderAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.CylinderAttributeControl.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.Control.

◆ SetOrientation()

HPS.CylinderAttributeControl HPS.CylinderAttributeControl.SetOrientation ( HPS.Cylinder.Orientation  in_orientation)
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.

Parameters
in_orientationThe orientation of colors and radii of cylinders.
Returns
A reference to this object.

◆ SetTessellation()

HPS.CylinderAttributeControl HPS.CylinderAttributeControl.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.

◆ ShowOrientation()

bool HPS.CylinderAttributeControl.ShowOrientation ( out HPS.Cylinder.Orientation  out_adjust)
inline

Shows the orientation of colors and radii of cylinders.

Returns
true if the setting is valid, false otherwise.

◆ ShowTessellation()

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

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

Parameters
out_facetsWhether text should be bold.
Returns
true if the setting is valid, false otherwise.

◆ Type()

override HPS.Type HPS.CylinderAttributeControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetEverything()

HPS.CylinderAttributeControl HPS.CylinderAttributeControl.UnsetEverything ( )
inline

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CylinderAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetOrientation()

HPS.CylinderAttributeControl HPS.CylinderAttributeControl.UnsetOrientation ( )
inline

Removes the cylinder orientation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CylinderAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetTessellation()

HPS.CylinderAttributeControl HPS.CylinderAttributeControl.UnsetTessellation ( )
inline

Removes the cylinder tessellation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CylinderAttributeKit.GetDefault().

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.CylinderAttributeControl.cs