HPS::CircleKey Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::CircleKey:

Collaboration diagram for HPS::CircleKey:

Public Member Functions
	CircleKey ()
	The default constructor creates an uninitialized CircleKey object. More...
	CircleKey (Key const &in_that)
	This constructor creates a CircleKey object that shares the underlying smart-pointer of the source Key. More...
	CircleKey (CircleKey const &in_that)
	The copy constructor creates a CircleKey object that shares the underlying smart-pointer of the source CircleKey. More...
CircleKey &	operator= (CircleKey const &in_that)
	Associate this CircleKey with the same underlying impl as the source CircleKey. More...
	CircleKey (CircleKey &&in_that)
	The move constructor creates a CircleKey by transferring the underlying impl of the rvalue reference to this CircleKey thereby avoiding a copy and allocation. More...
CircleKey &	operator= (CircleKey &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CircleKey thereby avoiding a copy. More...
	~CircleKey ()
HPS::Type	ObjectType () const
void	Consume (CircleKit &in_kit)
	Completely replaces all settings on this CircleKey with those set on the specified kit and resets the kit. More...
void	Set (CircleKit const &in_kit)
	Replace those settings on this CircleKey with those set on the specified kit. More...
void	Show (CircleKit &out_kit) const
	Copy the contents of this CircleKey into the specified kit. More...
CircleKey &	SetCenter (Point const &in_center)
	Sets the center point for this CircleKey. More...
CircleKey &	SetRadius (float in_radius)
	Sets the radius for this CircleKey. More...
CircleKey &	SetNormal (Vector const &in_normal)
	Sets the normal for this CircleKey. More...
bool	ShowCenter (Point &out_center) const
	Shows the center point for this CircleKey. More...
bool	ShowRadius (float &out_radius) const
	Shows the radius for this CircleKey. More...
bool	ShowNormal (Vector &out_normal) const
	Shows the normal for this CircleKey. 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::CircleKey

Detailed Description

The CircleKey class is a smart pointer to a database object.

It is a handle to a circle inserted via SegmentKey::InsertCircle. A circle has face geometry contained within its circumference. The visualization of the circle will be determined by attribute settings affecting faces and edges.

Constructor & Destructor Documentation

CircleKey() [1/4]

HPS::CircleKey::CircleKey

(

)

The default constructor creates an uninitialized CircleKey object.

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

CircleKey() [2/4]

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

explicit

This constructor creates a CircleKey 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 Circle key. Otherwise the copy will fail and the resulting CircleKey will be invalid.

Parameters

in_key

The source Key to copy.

CircleKey() [3/4]

HPS::CircleKey::CircleKey

(

CircleKey const &

in_that

)

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

Parameters

in_that

The source CircleKey to copy.

CircleKey() [4/4]

HPS::CircleKey::CircleKey

(

CircleKey &&

in_that

)

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

Parameters

in_that

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

~CircleKey()

HPS::CircleKey::~CircleKey

(

)

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::CircleKey::Consume

(

CircleKit &

in_kit

)

Completely replaces all settings on this CircleKey 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 CircleKey.

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.

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.

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::CircleKey::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]

CircleKey& HPS::CircleKey::operator=

(

CircleKey const &

in_that

)

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

Parameters

in_that

The source CircleKey for the assignment.

Returns

A reference to this CircleKey.

operator=() [2/2]

CircleKey& HPS::CircleKey::operator=

(

CircleKey &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this CircleKey.

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::CircleKey::Set

(

CircleKit const &

in_kit

)

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

Parameters

in_kit

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

SetCenter()

CircleKey& HPS::CircleKey::SetCenter

(

Point const &

in_center

)

Sets the center point for this CircleKey.

Parameters

in_center

The center point for this CircleKey.

Returns

A reference to this CircleKey.

SetNormal()

CircleKey& HPS::CircleKey::SetNormal

(

Vector const &

in_normal

)

Sets the normal for this CircleKey.

This is the normal for the plane in which the circle lies.

Parameters

in_normal

The normal for this CircleKey.

Returns

A reference to this CircleKey.

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

SetRadius()

CircleKey& HPS::CircleKey::SetRadius

(

float

in_radius

)

Sets the radius for this CircleKey.

Parameters

in_radius

The radius for this CircleKey.

Returns

A reference to this CircleKey.

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.

Show()

void HPS::CircleKey::Show

(

CircleKit &

out_kit

)

const

Copy the contents of this CircleKey into the specified kit.

Parameters

out_kit

The kit to populate with the contents of this CircleKey.

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.

ShowCenter()

bool HPS::CircleKey::ShowCenter

(

Point &

out_center

)

const

Shows the center point for this CircleKey.

Parameters

out_center

The center point for this CircleKey.

Returns

true if a center point was set, false otherwise.

ShowNormal()

bool HPS::CircleKey::ShowNormal

(

Vector &

out_normal

)

const

Shows the normal for this CircleKey.

Parameters

out_normal

The normal for this CircleKey.

Returns

true if a normal was 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.

ShowRadius()

bool HPS::CircleKey::ShowRadius

(

float &

out_radius

)

const

Shows the radius for this CircleKey.

Parameters

out_radius

The radius for this CircleKey.

Returns

true if a radius was set, 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.

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::CircleKey::staticType = HPS::Type::CircleKey

static

---

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

• hps.h