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

Public Member Functions | |
CylinderAttributeKit () | |
Initializes an empty kit. More... | |
CylinderAttributeKit (HPS.CylinderAttributeKit in_kit) | |
The copy constructor creates a new CylinderAttributeKit object that contains the same settings as the source object. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CylinderAttributeKit in_kit) |
Check if the source CylinderAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
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... | |
void | Set (HPS.CylinderAttributeKit in_kit) |
Copies all settings from the source CylinderAttributeKit into this object. More... | |
HPS.CylinderAttributeKit | SetOrientation (HPS.Cylinder.Orientation in_adjust) |
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.CylinderAttributeKit | SetTessellation (ulong in_facets) |
Sets the number of faces that should be generated around cylinders. More... | |
void | Show (out HPS.CylinderAttributeKit out_kit) |
Copies all settings from this CylinderAttributeKit into the given CylinderAttributeKit. More... | |
bool | ShowOrientation (out HPS.Cylinder.Orientation out_orientation) |
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.CylinderAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.CylinderAttributeKit | UnsetOrientation () |
Removes the cylinder orientation setting. More... | |
HPS.CylinderAttributeKit | UnsetTessellation () |
Removes the cylinder tessellation setting. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
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... | |
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... | |
![]() | |
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... | |
Static Public Member Functions | |
static HPS.CylinderAttributeKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.CylinderAttributeKit a, HPS.CylinderAttributeKit b) |
static bool | operator== (HPS.CylinderAttributeKit a, HPS.CylinderAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new CylinderAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
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.
|
inline |
Check if the source CylinderAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source CylinderAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
|
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.
|
inline |
Copies all settings from the source CylinderAttributeKit into this object.
- Parameters
-
in_kit The source CylinderAttributeKit to copy.
|
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.
|
inline |
Sets the number of faces that should be generated around cylinders.
- Parameters
-
in_facets the number of faces that should be generated around cylinders.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this CylinderAttributeKit into the given CylinderAttributeKit.
- Parameters
-
out_kit The CylinderAttributeKit to populate with the contents of this object.
|
inline |
Shows the orientation of colors and radii of cylinders.
- Parameters
-
out_orientation The orientation of colors and radii of cylinders.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the number of faces that should be generated around cylinders.
- Parameters
-
out_facets The number of faces that should be generated around cylinders
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the cylinder orientation setting.
- Returns
- A reference to this object.
|
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