HPS.CuttingSectionKey Class Reference

The CuttingSectionKey class is a smart pointer to a database object. It is a handle to a cutting section inserted via SegmentKey::InsertCuttingSection. More...

Inheritance diagram for HPS.CuttingSectionKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

void Consume (HPS.CuttingSectionKit in_kit)
 Completely replaces all settings on this CuttingSectionKey with those set on the specified kit and resets the kit. More...
 
 CuttingSectionKey ()
 The default constructor creates an uninitialized CuttingSectionKey object. The Type() function will return Type::None. More...
 
 CuttingSectionKey (HPS.Key in_that)
 This constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a CuttingSection key. Otherwise the copy will fail and the resulting CuttingSectionKey will be invalid. More...
 
 CuttingSectionKey (HPS.CuttingSectionKey in_that)
 The copy constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source CuttingSectionKey. More...
 
override void Dispose ()
 
HPS.CuttingSectionKey EditPlanesByDeletion (ulong in_offset, ulong in_count)
 Removes planes from the cutting plane list for this CuttingSectionKey. More...
 
HPS.CuttingSectionKey EditPlanesByInsertion (ulong in_offset, HPS.Plane[] in_planes)
 Adds cutting planes to this CuttingSectionKey. More...
 
HPS.CuttingSectionKey EditPlanesByReplacement (ulong in_offset, HPS.Plane[] in_planes)
 Replaces planes in the cutting plane list for this CuttingSectionKey. More...
 
ulong GetPlaneCount ()
 Gets the number of cutting planes for this CuttingSectionKey. 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.CuttingSectionKit in_kit)
 Replace those settings on this CuttingSectionKey with those set on the specified kit. More...
 
HPS.CuttingSectionKey SetPlanes (HPS.Plane in_plane)
 Sets a single cutting plane for this CuttingSectionKey. More...
 
HPS.CuttingSectionKey SetPlanes (HPS.Plane[] in_planes)
 Sets multiple cutting planes for this CuttingSectionKey. More...
 
HPS.CuttingSectionKey SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color, float in_scale)
 Sets visualization to use for this CuttingSectionKey. More...
 
HPS.CuttingSectionKey SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color)
 Sets visualization to use for this CuttingSectionKey. More...
 
void Show (out HPS.CuttingSectionKit out_kit)
 Copy the contents of this CuttingSectionKey into the specified kit. More...
 
bool ShowPlanes (out HPS.Plane[] out_planes)
 Shows the cutting planes for this CuttingSectionKey. More...
 
bool ShowVisualization (out HPS.CuttingSection.Mode out_mode, out HPS.RGBAColor out_color, out float out_scale)
 Shows the visualization to use for this CuttingSectionKey. More...
 
- Public Member Functions inherited from HPS.GeometryKey
override void Dispose ()
 
 GeometryKey ()
 The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type::None. More...
 
 GeometryKey (HPS.Key in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More...
 
 GeometryKey (HPS.GeometryKey in_that)
 The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. 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...
 
HPS.GeometryKey SetPriority (int in_priority)
 Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion. More...
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this key. More...
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this key. More...
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this key. More...
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 Shows the bounding of this geometry. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key. More...
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 Shows the all the references to this key. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this key. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this key. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this key. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this key. More...
 
HPS.GeometryKey UnsetAllUserData ()
 Removes all user data from this key. More...
 
HPS.GeometryKey UnsetPriority ()
 Removes the drawing priority setting. More...
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this key. More...
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this key. More...
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 Share the underlying smart-pointer of the Key source. More...
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 Copies the database object referred to by this key into a segment pointed to by in_destination. More...
 
void Delete ()
 Removes the database object referred to by this key. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 Determines whether the database objects pointed to by this key and in_that are the same. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More...
 
ulong GetHash ()
 Returns a hash code for the key. More...
 
override int GetHashCode ()
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

 
 Key ()
 An uninitialized key refers to no database object and Type() will return Type::None. More...
 
 Key (HPS.Key in_that)
 Shares a reference to a database object referred to by in_that. More...
 
 Key (HPS.Control in_control)
 Initializes a key tied to the Control in_control. More...
 
void MoveTo (HPS.SegmentKey in_new_owner)
 Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. 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...
 
HPS.SegmentKey Owner ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
- 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.GeometryKey
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Key
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- 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 CuttingSectionKey class is a smart pointer to a database object. It is a handle to a cutting section inserted via SegmentKey::InsertCuttingSection.

Constructor & Destructor Documentation

HPS.CuttingSectionKey.CuttingSectionKey ( )
inline

The default constructor creates an uninitialized CuttingSectionKey object. The Type() function will return Type::None.

HPS.CuttingSectionKey.CuttingSectionKey ( HPS.Key  in_that)
inline

This constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a CuttingSection key. Otherwise the copy will fail and the resulting CuttingSectionKey will be invalid.

Parameters
in_thatThe source Key to copy.
HPS.CuttingSectionKey.CuttingSectionKey ( HPS.CuttingSectionKey  in_that)
inline

The copy constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source CuttingSectionKey.

Parameters
in_thatThe source CuttingSectionKey to copy.

Member Function Documentation

void HPS.CuttingSectionKey.Consume ( HPS.CuttingSectionKit  in_kit)
inline

Completely replaces all settings on this CuttingSectionKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this CuttingSectionKey.
HPS.CuttingSectionKey HPS.CuttingSectionKey.EditPlanesByDeletion ( ulong  in_offset,
ulong  in_count 
)
inline

Removes planes from the cutting plane list for this CuttingSectionKey.

Parameters
in_offsetThe offset into the cutting planes for this CuttingSectionKey at which to start removing planes. This value must be such that in_offset<cutting_plane_count for deletion to succeed.
in_countThe number of planes to remove from the cutting plane list for this CuttingSectionKey. This value must be such that in_offset+in_count<=cutting_plane_count for the deletion to succeed.
Returns
A reference to this CuttingSectionKey.
HPS.CuttingSectionKey HPS.CuttingSectionKey.EditPlanesByInsertion ( ulong  in_offset,
HPS.Plane[]  in_planes 
)
inline

Adds cutting planes to this CuttingSectionKey.

Parameters
in_offsetThe offset into the cutting plane list for the CuttingSectionKey at which to insert planes. This value must be such that in_offset<cutting_plane_count for insertion to succeed.
in_planesThe planes to insert into the cutting plane list at the specified offset.
Returns
A reference to this CuttingSectionKey.
HPS.CuttingSectionKey HPS.CuttingSectionKey.EditPlanesByReplacement ( ulong  in_offset,
HPS.Plane[]  in_planes 
)
inline

Replaces planes in the cutting plane list for this CuttingSectionKey.

Parameters
in_offsetThe offset into the cutting plane list for this CuttingSectionKey at which to start replacing planes. This value must be such that in_offset < cutting_plane_count for replacement to succeed.
in_planesThe planes to use to replace those in the cutting plane list at the specified offset. The size of this array must be such that in_offset+in_planes.size()<=cutting_plane_count for the replacement to succeed.
Returns
A reference to this CuttingSectionKey.
ulong HPS.CuttingSectionKey.GetPlaneCount ( )
inline

Gets the number of cutting planes for this CuttingSectionKey.

Returns
The number of cutting planes for this CuttingSectionKey.
override HPS.Type HPS.CuttingSectionKey.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.CuttingSectionKey.Set ( HPS.CuttingSectionKit  in_kit)
inline

Replace those settings on this CuttingSectionKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this CuttingSectionKey.
HPS.CuttingSectionKey HPS.CuttingSectionKey.SetPlanes ( HPS.Plane  in_plane)
inline

Sets a single cutting plane for this CuttingSectionKey.

Parameters
in_planeThe cutting plane for this CuttingSectionKey.
Returns
A reference to this CuttingSectionKey.
HPS.CuttingSectionKey HPS.CuttingSectionKey.SetPlanes ( HPS.Plane[]  in_planes)
inline

Sets multiple cutting planes for this CuttingSectionKey.

Parameters
in_planesThe cutting planes for this CuttingSectionKey.
Returns
A reference to this CuttingSectionKey.
HPS.CuttingSectionKey HPS.CuttingSectionKey.SetVisualization ( HPS.CuttingSection.Mode  in_mode,
HPS.RGBAColor  in_color,
float  in_scale 
)
inline

Sets visualization to use for this CuttingSectionKey.

Parameters
in_modeThe mode for the CuttingSectionKey.
in_colorThe RGBA color for the CuttingSectionKey.
in_scaleThe scale to apply to the visualization geometry for this CuttingSectionKey. Defaults to 1.0f.
Returns
A reference to this CuttingSectionKey.
HPS.CuttingSectionKey HPS.CuttingSectionKey.SetVisualization ( HPS.CuttingSection.Mode  in_mode,
HPS.RGBAColor  in_color 
)
inline

Sets visualization to use for this CuttingSectionKey.

Parameters
in_modeThe mode for the CuttingSectionKey.
in_colorThe RGBA color for the CuttingSectionKey.
Returns
A reference to this CuttingSectionKey.
void HPS.CuttingSectionKey.Show ( out HPS.CuttingSectionKit  out_kit)
inline

Copy the contents of this CuttingSectionKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this CuttingSectionKey.
bool HPS.CuttingSectionKey.ShowPlanes ( out HPS.Plane[]  out_planes)
inline

Shows the cutting planes for this CuttingSectionKey.

Parameters
out_planesThe cutting planes for this CuttingSectionKey.
Returns
true if any cutting planes were set, false otherwise.
bool HPS.CuttingSectionKey.ShowVisualization ( out HPS.CuttingSection.Mode  out_mode,
out HPS.RGBAColor  out_color,
out float  out_scale 
)
inline

Shows the visualization to use for this CuttingSectionKey.

Parameters
out_modeThe mode for this CuttingSectionKey.
out_colorThe RGBA color for this CuttingSectionKey.
out_scaleThe scale to apply to the visualization geometry for this CuttingSectionKey.
Returns
true if visualization options were set, false otherwise.

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