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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.SphereAttributeControl SetTessellation (ulong in_facets)
 
bool ShowTessellation (out ulong out_facets)
 
 SphereAttributeControl (HPS.SegmentKey in_seg)
 
 SphereAttributeControl (HPS.SphereAttributeControl in_that)
 
override HPS.Type Type ()
 
HPS.SphereAttributeControl UnsetEverything ()
 
HPS.SphereAttributeControl 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.SphereAttributeControl class is a smart pointer that is tied to a database object. This control gives you access to the tessellation value for spheres. This table lists default values for the various segment attributes accessible from HPS.SphereAttributeControl.

Constructor & Destructor Documentation

◆ SphereAttributeControl() [1/2]

HPS.SphereAttributeControl.SphereAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ SphereAttributeControl() [2/2]

HPS.SphereAttributeControl.SphereAttributeControl ( HPS.SphereAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

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

◆ SetTessellation()

HPS.SphereAttributeControl HPS.SphereAttributeControl.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.
See also
Sphere tessellation default value

◆ ShowTessellation()

bool HPS.SphereAttributeControl.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.

◆ Type()

override HPS.Type HPS.SphereAttributeControl.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.SphereAttributeControl HPS.SphereAttributeControl.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 SphereAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetTessellation()

HPS.SphereAttributeControl HPS.SphereAttributeControl.UnsetTessellation ( )
inline

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

Returns
A reference to this object.

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