HPS::CuttingSectionKey Class Reference

The CuttingSectionKey class is a smart pointer to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::CuttingSectionKey:

Collaboration diagram for HPS::CuttingSectionKey:

Public Member Functions
	CuttingSectionKey ()
	The default constructor creates an uninitialized CuttingSectionKey object. More...
	CuttingSectionKey (Key const &in_that)
	This constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source Key. More...
	CuttingSectionKey (CuttingSectionKey const &in_that)
	The copy constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source CuttingSectionKey. More...
CuttingSectionKey &	operator= (CuttingSectionKey const &in_that)
	Associate this CuttingSectionKey with the same underlying impl as the source CuttingSectionKey. More...
	CuttingSectionKey (CuttingSectionKey &&in_that)
	The move constructor creates a CuttingSectionKey by transferring the underlying impl of the rvalue reference to this CuttingSectionKey thereby avoiding a copy and allocation. More...
CuttingSectionKey &	operator= (CuttingSectionKey &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CuttingSectionKey thereby avoiding a copy. More...
	~CuttingSectionKey ()
HPS::Type	ObjectType () const
void	Consume (CuttingSectionKit &in_kit)
	Completely replaces all settings on this CuttingSectionKey with those set on the specified kit and resets the kit. More...
void	Set (CuttingSectionKit const &in_kit)
	Replace those settings on this CuttingSectionKey with those set on the specified kit. More...
void	Show (CuttingSectionKit &out_kit) const
	Copy the contents of this CuttingSectionKey into the specified kit. More...
CuttingSectionKey &	SetPlanes (Plane const &in_plane)
	Sets a single cutting plane for this CuttingSectionKey. More...
CuttingSectionKey &	SetPlanes (PlaneArray const &in_planes)
	Sets multiple cutting planes for this CuttingSectionKey. More...
CuttingSectionKey &	SetPlanes (size_t in_count, Plane const in_planes[])
	Sets multiple cutting planes for this CuttingSectionKey. More...
CuttingSectionKey &	SetVisualization (CuttingSection::Mode in_mode, RGBAColor const &in_color, float in_scale=1.0f)
	Sets visualization to use for this CuttingSectionKey. More...
size_t	GetPlaneCount () const
	Gets the number of cutting planes for this CuttingSectionKey. More...
bool	ShowPlanes (HPS::PlaneArray &out_planes) const
	Shows the cutting planes for this CuttingSectionKey. More...
bool	ShowVisualization (CuttingSection::Mode &out_mode, RGBAColor &out_color, float &out_scale) const
	Shows the visualization to use for this CuttingSectionKey. More...
CuttingSectionKey &	EditPlanesByInsertion (size_t in_offset, size_t in_count, Plane const in_planes[])
	Adds cutting planes to this CuttingSectionKey. More...
CuttingSectionKey &	EditPlanesByInsertion (size_t in_offset, PlaneArray const &in_planes)
	Adds cutting planes to this CuttingSectionKey. More...
CuttingSectionKey &	EditPlanesByDeletion (size_t in_offset, size_t in_count)
	Removes planes from the cutting plane list for this CuttingSectionKey. More...
CuttingSectionKey &	EditPlanesByReplacement (size_t in_offset, size_t in_count, Plane const in_planes[])
	Replaces planes in the cutting plane list for this CuttingSectionKey. More...
CuttingSectionKey &	EditPlanesByReplacement (size_t in_offset, PlaneArray const &in_planes)
	Replaces planes in the cutting plane list for this CuttingSectionKey. More...
size_t	ShowReferrers (SegmentKeyArray &out_segments) const
	Shows the all the segments which contain references to this key. More...
size_t	ShowReferrers (ReferenceKeyArray &out_references) const
	Shows the all the references to this key. More...
GeometryKey &	SetPriority (int in_priority)
	Assigns a drawing priority value to the geometry. More...
GeometryKey &	UnsetPriority ()
	Removes the drawing priority setting. More...
bool	ShowPriority (int &out_priority) const
	Shows the drawing priority. More...
GeometryKey &	SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
	Sets user data on this key. More...
GeometryKey &	SetUserData (intptr_t in_index, ByteArray const &in_data)
	Sets user data on this key. More...
GeometryKey &	SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
	Sets user data on this key. More...
GeometryKey &	UnsetUserData (intptr_t in_index)
	Removes the user data at the given index from this key. More...
GeometryKey &	UnsetUserData (size_t in_count, intptr_t const in_indices[])
	Removes the user data at the given indices from this key. More...
GeometryKey &	UnsetUserData (IntPtrTArray const &in_indices)
	Removes the user data at the given indices from this key. More...
GeometryKey &	UnsetAllUserData ()
	Removes all user data from this key. More...
size_t	ShowUserDataCount () const
	Get the number of user data indices set on this key. More...
bool	ShowUserDataIndices (IntPtrTArray &out_indices) const
	Shows the indices of all user data set on this key. More...
bool	ShowUserData (intptr_t in_index, ByteArray &out_data) const
	Shows the user data at a given index for this key. More...
bool	ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
	Shows all user data for this key. More...
bool	ShowBounding (BoundingKit &out_kit) const
	Shows the bounding of this geometry. More...
bool	HasOwner () const
SegmentKey	Up () const
SegmentKey	Owner () const
void	Delete ()
	Removes the database object referred to by this key. More...
void	MoveTo (SegmentKey const &in_new_owner)
	Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More...
Key	CopyTo (SegmentKey const &in_destination) const
	Copies the database object referred to by this key into a segment pointed to by in_destination. More...
virtual void	Assign (Key const &in_that)
	Share the underlying smart-pointer of the Key source. More...
bool	Equals (Key const &in_that) const
	Determines whether the database objects pointed to by this key and in_that are the same. More...
bool	operator!= (Key const &in_that) const
	Determines whether the database objects pointed to by this key and in_that are the same. More...
bool	operator== (Key const &in_that) const
	Determines whether the database objects pointed to by this key and in_that are the same. More...
size_t	GetHash () const
	Returns a hash code for the key. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::CuttingSectionKey

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

CuttingSectionKey() [1/4]

HPS::CuttingSectionKey::CuttingSectionKey

(

)

The default constructor creates an uninitialized CuttingSectionKey object.

The Type() function will return Type::None.

CuttingSectionKey() [2/4]

HPS::CuttingSectionKey::CuttingSectionKey ( Key const &  in_that )

explicit

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_that

The source Key to copy.

CuttingSectionKey() [3/4]

HPS::CuttingSectionKey::CuttingSectionKey

(

CuttingSectionKey const &

in_that

)

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

Parameters

in_that

The source CuttingSectionKey to copy.

CuttingSectionKey() [4/4]

HPS::CuttingSectionKey::CuttingSectionKey

(

CuttingSectionKey &&

in_that

)

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

Parameters

in_that

An rvalue reference to a CuttingSectionKey to take the impl from.

~CuttingSectionKey()

HPS::CuttingSectionKey::~CuttingSectionKey

(

)

Member Function Documentation

Assign()

virtual void HPS::Key::Assign ( Key const &  in_that )

virtualinherited

Share the underlying smart-pointer of the Key source.

Parameters

in_that

The Key source of the assignment.

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

Consume()

void HPS::CuttingSectionKey::Consume

(

CuttingSectionKit &

in_kit

)

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

Parameters

in_kit

The kit from which to get the settings to replace on this CuttingSectionKey.

CopyTo()

Key HPS::Key::CopyTo ( SegmentKey const &  in_destination ) const

inherited

Copies the database object referred to by this key into a segment pointed to by in_destination.

Returns

The key of the new copy.

Delete()

void HPS::Key::Delete ( )

inherited

Removes the database object referred to by this key.

EditPlanesByDeletion()

CuttingSectionKey& HPS::CuttingSectionKey::EditPlanesByDeletion	(	size_t	in_offset,
		size_t	in_count
	)

Removes planes from the cutting plane list for this CuttingSectionKey.

Parameters

in_offset	The 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_count	The 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.

EditPlanesByInsertion() [1/2]

CuttingSectionKey& HPS::CuttingSectionKey::EditPlanesByInsertion	(	size_t	in_offset,
		size_t	in_count,
		Plane const	in_planes[]
	)

Adds cutting planes to this CuttingSectionKey.

Parameters

in_offset	The 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_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 CuttingSectionKey.

EditPlanesByInsertion() [2/2]

CuttingSectionKey& HPS::CuttingSectionKey::EditPlanesByInsertion	(	size_t	in_offset,
		PlaneArray const &	in_planes
	)

Adds cutting planes to this CuttingSectionKey.

Parameters

in_offset	The 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_planes	The planes to insert into the cutting plane list at the specified offset.

Returns

A reference to this CuttingSectionKey.

EditPlanesByReplacement() [1/2]

CuttingSectionKey& HPS::CuttingSectionKey::EditPlanesByReplacement	(	size_t	in_offset,
		size_t	in_count,
		Plane const	in_planes[]
	)

Replaces planes in the cutting plane list for this CuttingSectionKey.

Parameters

in_offset	The 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_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 CuttingSectionKey.

EditPlanesByReplacement() [2/2]

CuttingSectionKey& HPS::CuttingSectionKey::EditPlanesByReplacement	(	size_t	in_offset,
		PlaneArray const &	in_planes
	)

Replaces planes in the cutting plane list for this CuttingSectionKey.

Parameters

in_offset	The 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_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 CuttingSectionKey.

Empty()

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

true if no values are set on this object, false otherwise.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

Equals()

bool HPS::Key::Equals ( Key const &  in_that ) const

inherited

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

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetHash()

size_t HPS::Key::GetHash ( ) const

inherited

Returns a hash code for the key.

Returns

The size_t hash code.

Here is the caller graph for this function:

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

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.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

GetPlaneCount()

size_t HPS::CuttingSectionKey::GetPlaneCount

(

)

const

Gets the number of cutting planes for this CuttingSectionKey.

Returns

The number of cutting planes for this CuttingSectionKey.

HasOwner()

bool HPS::Key::HasOwner ( ) const

inherited

Returns

Indicates whether this key has an owner or not.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

MoveTo()

void HPS::Key::MoveTo ( SegmentKey const &  in_new_owner )

inherited

Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner.

ObjectType()

HPS::Type HPS::CuttingSectionKey::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::GeometryKey.

operator!=()

bool HPS::Key::operator!= ( Key const &  in_that ) const

inherited

Determines whether the database objects pointed to by this key and in_that are the same.

operator=() [1/2]

CuttingSectionKey& HPS::CuttingSectionKey::operator=

(

CuttingSectionKey const &

in_that

)

Associate this CuttingSectionKey with the same underlying impl as the source CuttingSectionKey.

Parameters

in_that

The source CuttingSectionKey for the assignment.

Returns

A reference to this CuttingSectionKey.

operator=() [2/2]

CuttingSectionKey& HPS::CuttingSectionKey::operator=

(

CuttingSectionKey &&

in_that

)

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

Parameters

in_that

An rvalue reference to a CuttingSectionKey to take the impl from.

Returns

A reference to this CuttingSectionKey.

operator==()

bool HPS::Key::operator== ( Key const &  in_that ) const

inherited

Determines whether the database objects pointed to by this key and in_that are the same.

Owner()

SegmentKey HPS::Key::Owner ( ) const

inherited

Returns

The segment containing this key.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

Set()

void HPS::CuttingSectionKey::Set

(

CuttingSectionKit const &

in_kit

)

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

Parameters

in_kit

The kit from which to get the settings to replace on this CuttingSectionKey.

SetPlanes() [1/3]

CuttingSectionKey& HPS::CuttingSectionKey::SetPlanes

(

Plane const &

in_plane

)

Sets a single cutting plane for this CuttingSectionKey.

Parameters

in_plane

The cutting plane for this CuttingSectionKey.

Returns

A reference to this CuttingSectionKey.

SetPlanes() [2/3]

CuttingSectionKey& HPS::CuttingSectionKey::SetPlanes

(

PlaneArray const &

in_planes

)

Sets multiple cutting planes for this CuttingSectionKey.

Parameters

in_planes

The cutting planes for this CuttingSectionKey.

Returns

A reference to this CuttingSectionKey.

SetPlanes() [3/3]

CuttingSectionKey& HPS::CuttingSectionKey::SetPlanes	(	size_t	in_count,
		Plane const	in_planes[]
	)

Sets multiple cutting planes for this CuttingSectionKey.

Parameters

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

Returns

A reference to this CuttingSectionKey.

SetPriority()

GeometryKey& HPS::GeometryKey::SetPriority ( int  in_priority )

inherited

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.

Parameters

in_priority

The drawing priority; higher priority items are drawn on top of lower priority items.

Returns

A reference to this object.

See also

SubwindowKit::SetRenderingAlgorithm()

SetUserData() [1/3]

GeometryKey& HPS::GeometryKey::SetUserData ( intptr_t  in_index, size_t  in_bytes, byte const  in_data[]  )

inherited

Sets user data on this key.

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

SetUserData() [2/3]

GeometryKey& HPS::GeometryKey::SetUserData ( intptr_t  in_index, ByteArray const &  in_data  )

inherited

Sets user data on this key.

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

SetUserData() [3/3]

GeometryKey& HPS::GeometryKey::SetUserData ( IntPtrTArray const &  in_indices, ByteArrayArray const &  in_data  )

inherited

Sets user data on this key.

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

SetVisualization()

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

Sets visualization to use for this CuttingSectionKey.

Parameters

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

Returns

A reference to this CuttingSectionKey.

Show()

void HPS::CuttingSectionKey::Show

(

CuttingSectionKit &

out_kit

)

const

Copy the contents of this CuttingSectionKey into the specified kit.

Parameters

out_kit

The kit to populate with the contents of this CuttingSectionKey.

ShowBounding()

bool HPS::GeometryKey::ShowBounding ( BoundingKit &  out_kit ) const

inherited

Shows the bounding of this geometry.

Parameters

out_kit

The BoundingKit that is set on this GeometryKey

Returns

False if no bounding exists.

ShowPlanes()

bool HPS::CuttingSectionKey::ShowPlanes

(

HPS::PlaneArray &

out_planes

)

const

Shows the cutting planes for this CuttingSectionKey.

Parameters

out_planes

The cutting planes for this CuttingSectionKey.

Returns

true if any cutting planes were set, false otherwise.

ShowPriority()

bool HPS::GeometryKey::ShowPriority ( int &  out_priority ) const

inherited

Shows the drawing priority.

Parameters

out_priority

The drawing priority; higher priority items are drawn on top of lower priority items.

Returns

true if a priority was specified, false otherwise.

ShowReferrers() [1/2]

size_t HPS::GeometryKey::ShowReferrers ( SegmentKeyArray &  out_segments ) const

inherited

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.

Parameters

out_segments

The list of segments which contains references to this key.

Returns

The number of segments which contain references to this key.

ShowReferrers() [2/2]

size_t HPS::GeometryKey::ShowReferrers ( ReferenceKeyArray &  out_references ) const

inherited

Shows the all the references to this key.

Parameters

out_references

The list of all references to this key.

Returns

The number of references to this key.

ShowUserData() [1/2]

bool HPS::GeometryKey::ShowUserData ( intptr_t  in_index, ByteArray &  out_data  ) const

inherited

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

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.

ShowUserData() [2/2]

bool HPS::GeometryKey::ShowUserData ( IntPtrTArray &  out_indices, ByteArrayArray &  out_data  ) const

inherited

Shows all user data for this key.

Parameters

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

Returns

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

ShowUserDataCount()

size_t HPS::GeometryKey::ShowUserDataCount ( ) const

inherited

Get the number of user data indices set on this key.

ShowUserDataIndices()

bool HPS::GeometryKey::ShowUserDataIndices ( IntPtrTArray &  out_indices ) const

inherited

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

Parameters

out_indices

The user data indices set on this key.

Returns

The number of user data indices set on this key.

ShowVisualization()

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

Shows the visualization to use for this CuttingSectionKey.

Parameters

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

Returns

true if visualization options were set, false otherwise.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

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 in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

UnsetAllUserData()

GeometryKey& HPS::GeometryKey::UnsetAllUserData ( )

inherited

Removes all user data from this key.

Returns

A reference to this key.

UnsetPriority()

GeometryKey& HPS::GeometryKey::UnsetPriority ( )

inherited

Removes the drawing priority setting.

Returns

A reference to this object.

UnsetUserData() [1/3]

GeometryKey& HPS::GeometryKey::UnsetUserData ( intptr_t  in_index )

inherited

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

Parameters

in_index

The index of the user data to remove.

Returns

A reference to this key.

UnsetUserData() [2/3]

GeometryKey& HPS::GeometryKey::UnsetUserData ( size_t  in_count, intptr_t const  in_indices[]  )

inherited

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

Parameters

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

Returns

A reference to this key.

UnsetUserData() [3/3]

GeometryKey& HPS::GeometryKey::UnsetUserData ( IntPtrTArray const &  in_indices )

inherited

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

Parameters

in_indices

The indices of the user data to remove.

Returns

A reference to this key.

Up()

SegmentKey HPS::Key::Up ( ) const

inherited

Returns

The segment containing this key.

Member Data Documentation

staticType

const HPS::Type HPS::CuttingSectionKey::staticType = HPS::Type::CuttingSectionKey

static

---

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

• hps.h