CuttingSectionKit

class HPS::CuttingSectionKit : public HPS::Kit 

The CuttingSectionKit class is a user space object. It is a kit analog to a CuttingSectionKey.

Public Functions

void Consume(CuttingSectionKit &in_kit)

Copies the source CuttingSectionKit into this CuttingSectionKit and resets the source kit.

Parameters: in_kit – The source CuttingSectionKit to consume.

CuttingSectionKit(): The default constructor creates an empty CuttingSectionKit object.

CuttingSectionKit(CuttingSectionKit &&in_that)

The move constructor creates a CuttingSectionKit by transferring the underlying impl of the rvalue reference to this CuttingSectionKit thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a CuttingSectionKit to take the impl from.

CuttingSectionKit(CuttingSectionKit const &in_kit)

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

Parameters: in_kit – The source CuttingSectionKit to copy.

CuttingSectionKit &EditPlanesByDeletion(size_t in_offset, size_t in_count)

Removes planes from the cutting plane list for this CuttingSectionKit.

Parameters

in_offset – The offset into the cutting planes for this CuttingSectionKit at which to start removing planes. This value must be such that in_offset<cutting_plane_count for deletion to succeed.
in_count – The number of planes to remove from the cutting plane list for this CuttingSectionKit. This value must be such that in_offset+in_count<=cutting_plane_count for the deletion to succeed.

Returns

A reference to this CuttingSectionKit.

CuttingSectionKit &EditPlanesByInsertion(size_t in_offset, PlaneArray const &in_planes)

Adds cutting planes to this CuttingSectionKit.

Parameters

in_offset – The offset into the cutting plane list for the CuttingSectionKit at which to insert planes. This value must be such that in_offset <= cutting_plane_count for insertion to succeed.
in_planes – The planes to insert into the cutting plane list at the specified offset.

Returns

A reference to this CuttingSectionKit.

CuttingSectionKit &EditPlanesByInsertion(size_t in_offset, size_t in_count, Plane const in_planes[])

Adds cutting planes to this CuttingSectionKit.

Parameters

in_offset – The offset into the cutting plane list for the CuttingSectionKit at which to insert planes. This value must be such that in_offset <= cutting_plane_count for insertion to succeed.
in_count – Size of the following array.
in_planes – The planes to insert into the cutting plane list at the specified offset.

Returns

A reference to this CuttingSectionKit.

CuttingSectionKit &EditPlanesByReplacement(size_t in_offset, PlaneArray const &in_planes)

Replaces planes in the cutting plane list for this CuttingSectionKit.

Parameters

in_offset – The offset into the cutting plane list for this CuttingSectionKit at which to start replacing planes. This value must be such that in_offset<cutting_plane_count for replacement to succeed.
in_count – Size of the following array. This value must be such that in_offset+in_count<=cutting_plane_count for the replacement to succeed.
in_planes – The 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 CuttingSectionKit.

CuttingSectionKit &EditPlanesByReplacement(size_t in_offset, size_t in_count, Plane const in_planes[])

Replaces planes in the cutting plane list for this CuttingSectionKit.

Parameters

in_offset – The offset into the cutting plane list for this CuttingSectionKit at which to start replacing planes. This value must be such that in_offset<cutting_plane_count for replacement to succeed.
in_count – Size of the following array. This value must be such that in_offset+in_count<=cutting_plane_count for the replacement to succeed.
in_planes – The planes to use to replace those in the cutting plane list at the specified offset.

Returns

A reference to this CuttingSectionKit.

virtual bool Empty() const

Indicates whether this CuttingSectionKit has any values set on it.

Returns: true if no values are set on this CuttingSectionKit, false otherwise.

bool Equals(CuttingSectionKit const &in_kit) const

Check if the source CuttingSectionKit is equivalent to this CuttingSectionKit.

Parameters: in_kit – The source CuttingSectionKit to compare to this CuttingSectionKit.
Returns: true if the objects are equivalent, false otherwise.

size_t GetPlaneCount() const

Gets the number of cutting planes for this CuttingSectionKit.

Returns: The number of cutting planes for this CuttingSectionKit.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(CuttingSectionKit const &in_kit) const

Check if the source CuttingSectionKit is not equivalent to this CuttingSectionKit.

Parameters: in_kit – The source CuttingSectionKit to compare to this CuttingSectionKit.
Returns: true if the objects are not equivalent, false otherwise.

CuttingSectionKit &operator=(CuttingSectionKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this CuttingSectionKit thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a CuttingSectionKit to take the impl from.
Returns: A reference to this CuttingSectionKit.

CuttingSectionKit &operator=(CuttingSectionKit const &in_kit)

Copies the source CuttingSectionKit into this CuttingSectionKit.

Parameters: in_kit – The source CuttingSectionKit to copy.
Returns: A reference to this CuttingSectionKit.

bool operator==(CuttingSectionKit const &in_kit) const

Check if the source CuttingSectionKit is equivalent to this CuttingSectionKit.

Parameters: in_kit – The source CuttingSectionKit to compare to this CuttingSectionKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(CuttingSectionKit const &in_kit)

Copies the source CuttingSectionKit into this CuttingSectionKit.

Parameters: in_kit – The source CuttingSectionKit to copy.

CuttingSectionKit &SetPlanes(Plane const &in_plane)

Sets a single cutting plane for this CuttingSectionKit.

Parameters: in_plane – The cutting plane for this CuttingSectionKit.
Returns: A reference to this CuttingSectionKit.

CuttingSectionKit &SetPlanes(PlaneArray const &in_planes)

Sets multiple cutting planes for this CuttingSectionKit.

Parameters: in_planes – The cutting planes for this CuttingSectionKit.
Returns: A reference to this CuttingSectionKit.

CuttingSectionKit &SetPlanes(size_t in_count, Plane const in_planes[])

Sets multiple cutting planes for this CuttingSectionKit.

Parameters

in_count – Size of the following array.
in_planes – The cutting planes for this CuttingSectionKit.

Returns

A reference to this CuttingSectionKit.

CuttingSectionKit &SetPriority(int in_priority)

Assigns a specific drawing priority value to the CuttingSectionKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

See: SubwindowKit::SetPriority()
See: SubwindowKit::SetRenderingAlgorithm()

Parameters: in_priority – The drawing priority, higher priority items are drawn on top of lower priority items.
Returns: A reference to this object.

CuttingSectionKit &SetUserData(intptr_t in_index, ByteArray const &in_data)

Sets user data on this kit.

Parameters

in_index – The index of the user data to set.
in_data – The bytes of user data to set.

Returns

A reference to this kit.

CuttingSectionKit &SetUserData(intptr_t in_index, size_t in_bytes, byte const in_data[])

Sets user data on this kit.

Parameters

in_index – The index of the user data to set.
in_bytes – The number of bytes of user data to set.
in_data – The bytes of user data to set.

Returns

A reference to this kit.

CuttingSectionKit &SetUserData(IntPtrTArray const &in_indices, ByteArrayArray const &in_data)

Sets user data on this kit.

Parameters

in_indices – An array of user data indices to set.
in_data – An array of bytes of user data to set.

Returns

A reference to this kit.

CuttingSectionKit &SetVisualization(CuttingSection::Mode in_mode, RGBAColor const &in_color, float in_scale = 1.0f)

Sets visualization to use for this CuttingSectionKit.

Parameters

in_mode – The mode for the CuttingSectionKit.
in_color – The RGBA color for the CuttingSectionKit.
in_scale – The scale to apply to the visualization geometry for this CuttingSectionKit. Defaults to 1.0f.

Returns

A reference to this CuttingSectionKit.

void Show(CuttingSectionKit &out_kit) const

Copies this CuttingSectionKit into the given CuttingSectionKit.

Parameters: out_kit – The CuttingSectionKit to populate with the contents of this CuttingSectionKit.

bool ShowPlanes(HPS::PlaneArray &out_planes) const

Shows the cutting planes for this CuttingSectionKit.

Parameters: out_planes – The cutting planes for this CuttingSectionKit.
Returns: true if any cutting planes were set, false otherwise.

bool ShowPriority(int &out_priority) const

Shows the drawing priority.

Parameters: out_priority – The drawing priority, higher priority items are drawn on top of lower priority items.
Returns: true if the setting is valid, false otherwise.

bool ShowUserData(intptr_t in_index, ByteArray &out_data) const

Shows the user data at a given index for this kit.

Parameters

in_index – The index of the user data to show.
out_data – The user data at the given index.

Returns

true if there is user data at the given index, false otherwise.

bool ShowUserData(IntPtrTArray &out_indices, ByteArrayArray &out_data) const

Shows all user data for this kit.

Parameters

out_indices – An array of all user data indices set on this kit.
out_data – An array of all user data set on this kit.

Returns

true if there is user data on this kit, false otherwise.

size_t ShowUserDataCount() const: Get the number of user data indices set on this kit.

bool ShowUserDataIndices(IntPtrTArray &out_indices) const

Shows the indices of all user data set on this kit.

Parameters: out_indices – The user data indices set on this kit.
Returns: The number of user data indices set on this kit.

bool ShowVisualization(CuttingSection::Mode &out_mode, RGBAColor &out_color, float &out_scale) const

Shows the visualization to use for this CuttingSectionKit.

Parameters

out_mode – The mode for this CuttingSectionKit.
out_color – The RGBA color for this CuttingSectionKit.
out_scale – The scale to apply to the visualization geometry for this CuttingSectionKit.

Returns

true if visualization options were set, false otherwise.

CuttingSectionKit &UnsetAllUserData()

Removes all user data from this kit.

Returns: A reference to this kit.

CuttingSectionKit &UnsetEverything()

Removes all settings from the CuttingSectionKit.

Returns: A reference to this CuttingSectionKit.

CuttingSectionKit &UnsetPlanes()

Removes the cutting planes for this CuttingSectionKit.

Returns: A reference to this CuttingSectionKit.

CuttingSectionKit &UnsetPriority()

Removes a drawing priority setting.

Returns: A reference to this object.

CuttingSectionKit &UnsetUserData(intptr_t in_index)

Removes the user data at the given index from this kit.

Parameters: in_index – The index of the user data to remove.
Returns: A reference to this kit.

CuttingSectionKit &UnsetUserData(IntPtrTArray const &in_indices)

Removes the user data at the given indices from this kit.

Parameters: in_indices – The indices of the user data to remove.
Returns: A reference to this kit.

CuttingSectionKit &UnsetUserData(size_t in_count, intptr_t const in_indices[])

Removes the user data at the given indices from this kit.

Parameters

in_count – The size of the following array.
in_indices – The indices of the user data to remove.

Returns

A reference to this kit.

CuttingSectionKit &UnsetVisualization()

Removes the visualization settings for this CuttingSectionKit.

Returns: A reference to this CuttingSectionKit.

virtual ~CuttingSectionKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CuttingSectionKit