Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.CuttingSectionAttributeKit Class Reference

The HPS::CuttingSectionAttributeKit class is a user space object which encapsulates a set of attributes pertaining to cutting sections. Calling HPS::CuttingSectionAttributeKit::GetDefault() will return a kit with values found in this table. More...

Inheritance diagram for HPS.CuttingSectionAttributeKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
 CuttingSectionAttributeKit ()
 Initializes an empty kit. More...
 
 CuttingSectionAttributeKit (HPS.CuttingSectionAttributeKit in_kit)
 The copy constructor creates a new CuttingSectionAttributeKit object that contains the same settings as the source object. More...
 
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.CuttingSectionAttributeKit in_kit)
 Copies all settings from the source CuttingSectionAttributeKit into this object. More...
 
void Show (out HPS.CuttingSectionAttributeKit out_kit)
 Copies all settings from this CuttingSectionAttributeKit into the given CuttingSectionAttributeKit. More...
 
override bool Empty ()
 Indicates whether this object has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.CuttingSectionAttributeKit in_kit)
 Check if the source CuttingSectionAttributeKit is equivalent to this object. More...
 
HPS.CuttingSectionAttributeKit SetCuttingLevel (HPS.CuttingSection.CuttingLevel in_level)
 Sets the cutting section cutting level. More...
 
HPS.CuttingSectionAttributeKit SetCappingLevel (HPS.CuttingSection.CappingLevel in_level)
 Sets the cutting section capping level. More...
 
HPS.CuttingSectionAttributeKit SetMaterialPreference (HPS.CuttingSection.MaterialPreference in_preference)
 Sets the material preference for cut geometry. More...
 
HPS.CuttingSectionAttributeKit UnsetCuttingLevel ()
 Removes the cutting section cutting level setting. More...
 
HPS.CuttingSectionAttributeKit UnsetCappingLevel ()
 Removes the cutting section capping level setting. More...
 
HPS.CuttingSectionAttributeKit UnsetMaterialPreference ()
 Removes the material preference for cut geometry setting. More...
 
HPS.CuttingSectionAttributeKit UnsetEverything ()
 Removes all settings from this object. More...
 
bool ShowCuttingLevel (out HPS.CuttingSection.CuttingLevel out_level)
 Shows the cutting section cutting level setting. More...
 
bool ShowCappingLevel (out HPS.CuttingSection.CappingLevel out_level)
 Shows the cutting section capping level setting. More...
 
bool ShowMaterialPreference (out HPS.CuttingSection.MaterialPreference out_preference)
 Shows the orientation of colors and radii of cylinders. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

Static Public Member Functions

static
HPS.CuttingSectionAttributeKit 
GetDefault ()
 Creates a CuttingSectionAttributeKit 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.CuttingSectionAttributeKit a, HPS.CuttingSectionAttributeKit b)
 
static bool operator!= (HPS.CuttingSectionAttributeKit a, HPS.CuttingSectionAttributeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The HPS::CuttingSectionAttributeKit class is a user space object which encapsulates a set of attributes pertaining to cutting sections. Calling HPS::CuttingSectionAttributeKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

HPS.CuttingSectionAttributeKit.CuttingSectionAttributeKit ( )
inline

Initializes an empty kit.

HPS.CuttingSectionAttributeKit.CuttingSectionAttributeKit ( HPS.CuttingSectionAttributeKit  in_kit)
inline

The copy constructor creates a new CuttingSectionAttributeKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

Member Function Documentation

override bool HPS.CuttingSectionAttributeKit.Empty ( )
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.

bool HPS.CuttingSectionAttributeKit.Equals ( HPS.CuttingSectionAttributeKit  in_kit)
inline

Check if the source CuttingSectionAttributeKit is equivalent to this object.

Parameters
in_kitThe source CuttingSectionAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.GetDefault ( )
inlinestatic

Creates a CuttingSectionAttributeKit 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 CuttingSectionAttributeKit with the default settings.
override HPS.Type HPS.CuttingSectionAttributeKit.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.

void HPS.CuttingSectionAttributeKit.Set ( HPS.CuttingSectionAttributeKit  in_kit)
inline

Copies all settings from the source CuttingSectionAttributeKit into this object.

Parameters
in_kitThe source CuttingSectionAttributeKit to copy.
HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.SetCappingLevel ( HPS.CuttingSection.CappingLevel  in_level)
inline

Sets the cutting section capping level.

Parameters
in_levelThe cutting section capping level.
Returns
A reference to this object.
HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.SetCuttingLevel ( HPS.CuttingSection.CuttingLevel  in_level)
inline

Sets the cutting section cutting level.

Parameters
in_levelThe cutting section cutting level.
Returns
A reference to this object.
HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.SetMaterialPreference ( HPS.CuttingSection.MaterialPreference  in_preference)
inline

Sets the material preference for cut geometry.

Parameters
in_preferenceThe material preference for cut geometry.
Returns
A reference to this object.
void HPS.CuttingSectionAttributeKit.Show ( out HPS.CuttingSectionAttributeKit  out_kit)
inline

Copies all settings from this CuttingSectionAttributeKit into the given CuttingSectionAttributeKit.

Parameters
out_kitThe CuttingSectionAttributeKit to populate with the contents of this object.
bool HPS.CuttingSectionAttributeKit.ShowCappingLevel ( out HPS.CuttingSection.CappingLevel  out_level)
inline

Shows the cutting section capping level setting.

Parameters
out_levelThe cutting section capping level.
Returns
true if a cutting section capping level setting was specified, false otherwise.
bool HPS.CuttingSectionAttributeKit.ShowCuttingLevel ( out HPS.CuttingSection.CuttingLevel  out_level)
inline

Shows the cutting section cutting level setting.

Parameters
out_levelThe cutting section cutting level.
Returns
true if a cutting section cutting level setting was specified, false otherwise.
bool HPS.CuttingSectionAttributeKit.ShowMaterialPreference ( out HPS.CuttingSection.MaterialPreference  out_preference)
inline

Shows the orientation of colors and radii of cylinders.

Parameters
out_preferenceThe material preference for cut geometry.
Returns
true if a material preference for cut geometry was specified, false otherwise.
HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetCappingLevel ( )
inline

Removes the cutting section capping level setting.

Returns
A reference to this object.
HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetCuttingLevel ( )
inline

Removes the cutting section cutting level setting.

Returns
A reference to this object.
HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.
HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetMaterialPreference ( )
inline

Removes the material preference for cut geometry setting.

Returns
A reference to this object.

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