API Search || Global Search
HPS.SphereAttributeControl Class Reference

More...

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

Public Member Functions

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.SphereAttributeControl SetTessellation (ulong in_facets)
 Sets the number of faces that should be generated around the equator of spheres. More...
 
bool ShowTessellation (out ulong out_facets)
 Shows the number of faces that should be generated around the equator of spheres. More...
 
 SphereAttributeControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 SphereAttributeControl (HPS.SphereAttributeControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
override 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...
 
HPS.SphereAttributeControl UnsetEverything ()
 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(). More...
 
HPS.SphereAttributeControl UnsetTessellation ()
 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(). 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...
 

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

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

Initializes a control tied to the segment in_seg.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

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

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.

Sphere tessellation default value

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

Returns
    The true type of the object in question.

Reimplemented from HPS.Control.

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