Overview

Sample Code

Programming Guide

API Reference

Support

HPS.CylinderAttributeControl Class Reference

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

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

Public Member Functions

 CylinderAttributeControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 CylinderAttributeControl (HPS.CylinderAttributeControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
override void Dispose ()
 
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...
 
HPS.CylinderAttributeControl SetOrientation (HPS.Cylinder.Orientation in_orientation)
 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. More...
 
HPS.CylinderAttributeControl SetTessellation (ulong in_facets)
 Sets the number of faces that should be generated around cylinders. More...
 
bool ShowOrientation (out HPS.Cylinder.Orientation out_adjust)
 Shows the orientation of colors and radii of cylinders. More...
 
bool ShowTessellation (out ulong out_facets)
 Shows the number of faces that should be generated around cylinders. More...
 
HPS.CylinderAttributeControl UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.CylinderAttributeControl UnsetOrientation ()
 Removes the cylinder orientation setting. More...
 
HPS.CylinderAttributeControl UnsetTessellation ()
 Removes the cylinder tessellation setting. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. 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...
 

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

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

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

Initializes a control tied to the segment in_seg.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

override HPS.Type HPS.CylinderAttributeControl.ObjectType ( )
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.

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.
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.
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.
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.
HPS.CylinderAttributeControl HPS.CylinderAttributeControl.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.
HPS.CylinderAttributeControl HPS.CylinderAttributeControl.UnsetOrientation ( )
inline

Removes the cylinder orientation setting.

Returns
A reference to this object.
HPS.CylinderAttributeControl HPS.CylinderAttributeControl.UnsetTessellation ( )
inline

Removes the cylinder tessellation setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file: