HPS::LineKey Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::LineKey:

Collaboration diagram for HPS::LineKey:

Public Member Functions
	LineKey ()
	The default constructor creates an uninitialized LineKey object. More...
	LineKey (Key const &in_that)
	This constructor creates a LineKey object that shares the underlying smart-pointer of the source Key. More...
	LineKey (LineKey const &in_that)
	The copy constructor creates a LineKey object that shares the underlying smart-pointer of the source LineKey. More...
LineKey &	operator= (LineKey const &in_that)
	Associate this LineKey with the same underlying impl as the source LineKey. More...
	LineKey (LineKey &&in_that)
	The move constructor creates a LineKey by transferring the underlying impl of the rvalue reference to this LineKey thereby avoiding a copy and allocation. More...
LineKey &	operator= (LineKey &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this LineKey thereby avoiding a copy. More...
	~LineKey ()
HPS::Type	ObjectType () const
void	Consume (LineKit &in_kit)
	Completely replaces all settings on this LineKey with those set on the specified kit and resets the kit. More...
void	Set (LineKit const &in_kit)
	Copies the source LineKit into this LineKit. More...
void	Show (LineKit &out_kit) const
	Copies this LineKit into the given LineKit. More...
size_t	GetPointCount () const
	Retrieves the number of points in this line. More...
LineKey &	SetPoints (PointArray const &in_points)
	Sets the points for this LineKey. More...
LineKey &	SetPoints (size_t in_count, Point const in_points [])
	Sets the points for this LineKey. More...
bool	ShowPoints (PointArray &out_points) const
	Shows the points for this LineKey. More...
bool	ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const
	Show a subset of the points for this LineKey by range. More...
bool	ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const
	Show a subset of the points for this LineKey by list. More...
bool	ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const
	Show a subset of the points for this LineKey by list. More...
LineKey &	SetPoints (PointArray const &in_points, LineCoordinateSpaceArray const &in_spaces)
	Sets the points for this LineKey. More...
LineKey &	SetPoints (size_t in_count, Point const in_points[], Line::CoordinateSpace const in_spaces[])
	Sets the points for this LineKey. More...
bool	ShowPoints (PointArray &out_points, LineCoordinateSpaceArray &out_coordinate_spaces) const
	Shows the points for this LineKey. More...
LineKey &	SetPointCoordinateSpace (size_t in_count, size_t const in_indices[], Line::CoordinateSpace const in_spaces[])
	Sets the coordinate space to use for each point of this line. More...
LineKey &	SetPointCoordinateSpace (SizeTArray const &in_indices, LineCoordinateSpaceArray const &in_spaces)
	Sets the coordinate space to use for each point of this line. More...
LineKey &	SetPointCoordinateSpace (LineCoordinateSpaceArray const &in_spaces)
	Sets the coordinate space to use for each point of this line. More...
LineKey &	SetPointCoordinateSpace (size_t in_count, Line::CoordinateSpace const in_spaces [])
	Sets the coordinate space to use for each point of this line. More...
LineKey &	UnsetPointCoordinateSpace (SizeTArray const &in_indices)
	Unsets the coordinate space for specified points on this line back to Coordinate::Space::Object. More...
LineKey &	UnsetPointCoordinateSpace (size_t in_count, size_t const in_indices[])
	Unsets the coordinate space for specified points on this line back to Coordinate::Space::Object. More...
LineKey &	UnsetPointCoordinateSpace ()
	Unsets the coordinate space for all points on this line back to Coordinate::Space::Object. More...
bool	ShowPointCoordinateSpace (size_t in_count, size_t const in_indices[], LineCoordinateSpaceArray &out_spaces) const
	Shows the coordinate space that is being used for the points at the specified indices. More...
bool	ShowPointCoordinateSpace (SizeTArray const &in_indices, LineCoordinateSpaceArray &out_spaces) const
	Shows the coordinate space that is being used for the points at the specified indices. More...
bool	ShowPointCoordinateSpace (LineCoordinateSpaceArray &out_spaces) const
	Shows the coordinate space that is being used for the points at the specified indices. More...
LineKey &	EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[])
	Adds points to the point list for this LineKey. More...
LineKey &	EditPointsByInsertion (size_t in_offset, PointArray const &in_points)
	Adds points to the point list for this LineKey. More...
LineKey &	EditPointsByDeletion (size_t in_offset, size_t in_count)
	Removes points from the point list for this LineKey. More...
LineKey &	EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[])
	Replaces points in the point list for this LineKey. More...
LineKey &	EditPointsByReplacement (size_t in_offset, PointArray const &in_points)
	Replaces points in the point list for this LineKey. 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::LineKey

Detailed Description

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

It is a handle to a line inserted via SegmentKey::InsertLine.

Constructor & Destructor Documentation

LineKey() [1/4]

HPS::LineKey::LineKey

(

)

The default constructor creates an uninitialized LineKey object.

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

LineKey() [2/4]

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

explicit

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

Parameters

in_name

The source Key to copy.

LineKey() [3/4]

HPS::LineKey::LineKey

(

LineKey const &

in_that

)

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

Parameters

in_that

The source LineKey to copy.

LineKey() [4/4]

HPS::LineKey::LineKey

(

LineKey &&

in_that

)

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

Parameters

in_that

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

~LineKey()

HPS::LineKey::~LineKey

(

)

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

(

LineKit &

in_kit

)

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

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.

EditPointsByDeletion()

LineKey& HPS::LineKey::EditPointsByDeletion	(	size_t	in_offset,
		size_t	in_count
	)

Removes points from the point list for this LineKey.

Parameters

in_offset	The offset into the point list for the line at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed.
in_count	The number of points to delete from the point list for the line. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.

Returns

A reference to this LineKey.

EditPointsByInsertion() [1/2]

LineKey& HPS::LineKey::EditPointsByInsertion	(	size_t	in_offset,
		size_t	in_count,
		Point const	in_points[]
	)

Adds points to the point list for this LineKey.

Parameters

in_offset	The offset into the point list for the line at which to insert points. This value must be such that in_offset<point_count for insertion to succeed.
in_count	Size of the following array.
in_points	The points to insert into the point list at the specified offset.

Returns

A reference to this LineKey.

EditPointsByInsertion() [2/2]

LineKey& HPS::LineKey::EditPointsByInsertion	(	size_t	in_offset,
		PointArray const &	in_points
	)

Adds points to the point list for this LineKey.

Parameters

in_offset	The offset into the point list for the line at which to insert points. This value must be such that in_offset<point_count for insertion to succeed.
in_points	The points to insert into the point list at the specified offset.

Returns

A reference to this LineKey.

EditPointsByReplacement() [1/2]

LineKey& HPS::LineKey::EditPointsByReplacement	(	size_t	in_offset,
		size_t	in_count,
		Point const	in_points[]
	)

Replaces points in the point list for this LineKey.

Parameters

in_offset	The offset into the point list for the line at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed.
in_count	Size of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed.
in_points	The points to use to replace those in the point list at the specified offset.

Returns

A reference to this LineKey.

EditPointsByReplacement() [2/2]

LineKey& HPS::LineKey::EditPointsByReplacement	(	size_t	in_offset,
		PointArray const &	in_points
	)

Replaces points in the point list for this LineKey.

Parameters

in_offset	The offset into the point list for the line at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed.
in_points	The points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.

Returns

A reference to this LineKey.

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.

GetPointCount()

size_t HPS::LineKey::GetPointCount

(

)

const

Retrieves the number of points in this line.

Returns

The number of points in this line.

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

LineKey& HPS::LineKey::operator=

(

LineKey const &

in_that

)

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

Parameters

in_that

The source LineKey for the assignment.

Returns

A reference to this LineKey.

operator=() [2/2]

LineKey& HPS::LineKey::operator=

(

LineKey &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this LineKey.

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

(

LineKit const &

in_kit

)

Copies the source LineKit into this LineKit.

Parameters

in_kit

The source LineKit to copy.

SetPointCoordinateSpace() [1/4]

LineKey& HPS::LineKey::SetPointCoordinateSpace	(	size_t	in_count,
		size_t const	in_indices[],
		Line::CoordinateSpace const	in_spaces[]
	)

Sets the coordinate space to use for each point of this line.

The default is Line::CoordinateSpace::Object.

Parameters

in_count	The number of points to unset.
in_indices	The list of point indices to unset.
in_spaces	The coordinate spaces for each point in the line.

Returns

A reference to this LineKey.

SetPointCoordinateSpace() [2/4]

LineKey& HPS::LineKey::SetPointCoordinateSpace	(	SizeTArray const &	in_indices,
		LineCoordinateSpaceArray const &	in_spaces
	)

Sets the coordinate space to use for each point of this line.

The default is Line::CoordinateSpace::Object.

Parameters

in_indices	The list of point indices to unset.
in_spaces	The coordinate spaces for each point in the line.

Returns

A reference to this LineKey.

SetPointCoordinateSpace() [3/4]

LineKey& HPS::LineKey::SetPointCoordinateSpace

(

LineCoordinateSpaceArray const &

in_spaces

)

Sets the coordinate space to use for each point of this line.

The default is Line::CoordinateSpace::Object.

Parameters

in_spaces

The coordinate spaces for each point in the line.

Returns

A reference to this LineKey.

SetPointCoordinateSpace() [4/4]

LineKey& HPS::LineKey::SetPointCoordinateSpace	(	size_t	in_count,
		Line::CoordinateSpace const	in_spaces[]
	)

Sets the coordinate space to use for each point of this line.

The default is Line::CoordinateSpace::Object.

Parameters

in_count	Size of the following array.
in_spaces	The coordinate spaces for each point in the line.

Returns

A reference to this LineKey.

SetPoints() [1/4]

LineKey& HPS::LineKey::SetPoints

(

PointArray const &

in_points

)

Sets the points for this LineKey.

Parameters

in_points

The points for this LineKey.

Returns

A reference to this LineKey.

SetPoints() [2/4]

LineKey& HPS::LineKey::SetPoints	(	size_t	in_count,
		Point const	in_points[]
	)

Sets the points for this LineKey.

Parameters

in_count	Size of the following array.
in_points	The points for this LineKey.

Returns

A reference to this LineKey.

SetPoints() [3/4]

LineKey& HPS::LineKey::SetPoints	(	PointArray const &	in_points,
		LineCoordinateSpaceArray const &	in_spaces
	)

Sets the points for this LineKey.

Parameters

in_points	The points for this LineKey.
in_spaces	The coordinate spaces for each point in the line.

Returns

A reference to this LineKey.

SetPoints() [4/4]

LineKey& HPS::LineKey::SetPoints	(	size_t	in_count,
		Point const	in_points[],
		Line::CoordinateSpace const	in_spaces[]
	)

Sets the points for this LineKey.

Parameters

in_count	Size of the following array.
in_points	The points for this LineKey.
in_spaces	The coordinate spaces for each point in the line.

Returns

A reference to this LineKey.

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.

Show()

void HPS::LineKey::Show

(

LineKit &

out_kit

)

const

Copies this LineKit into the given LineKit.

Parameters

out_kit

The LineKit to populate with the contents of this LineKit.

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.

ShowPointCoordinateSpace() [1/3]

bool HPS::LineKey::ShowPointCoordinateSpace	(	size_t	in_count,
		size_t const	in_indices[],
		LineCoordinateSpaceArray &	out_spaces
	)		const

Shows the coordinate space that is being used for the points at the specified indices.

Parameters

in_count	The number of points to show.
in_indices	The list of point indices to show.
out_spaces	The coordinate spaces for each index specified.

Returns

true if line coordinates could be retrieved for this line false otherwise.

ShowPointCoordinateSpace() [2/3]

bool HPS::LineKey::ShowPointCoordinateSpace	(	SizeTArray const &	in_indices,
		LineCoordinateSpaceArray &	out_spaces
	)		const

Shows the coordinate space that is being used for the points at the specified indices.

Parameters

in_indices	The list of point indices to show.
out_spaces	The coordinate spaces for each index specified.

Returns

true if line coordinates could be retrieved for this line false otherwise.

ShowPointCoordinateSpace() [3/3]

bool HPS::LineKey::ShowPointCoordinateSpace

(

LineCoordinateSpaceArray &

out_spaces

)

const

Shows the coordinate space that is being used for the points at the specified indices.

Parameters

out_spaces

The coordinate spaces for each all points on this line.

Returns

true if line coordinates could be retrieved for this line false otherwise.

ShowPoints() [1/2]

bool HPS::LineKey::ShowPoints

(

PointArray &

out_points

)

const

Shows the points for this LineKey.

Parameters

out_points

The points for this LineKey.

Returns

true if points were set, false otherwise.

ShowPoints() [2/2]

bool HPS::LineKey::ShowPoints	(	PointArray &	out_points,
		LineCoordinateSpaceArray &	out_coordinate_spaces
	)		const

Shows the points for this LineKey.

Parameters

out_points	The points for this LineKey.
out_coordinate_spaces	The coordinate spaces for each point in this line.

Returns

true if points were set, false otherwise.

ShowPointsByList() [1/2]

bool HPS::LineKey::ShowPointsByList	(	SizeTArray const &	in_indices,
		PointArray &	out_points
	)		const

Show a subset of the points for this LineKey by list.

Parameters

in_indices	The list of point indices to show.
out_points	The requested points for this LineKey.

Returns

true if all requested points were set, false otherwise.

ShowPointsByList() [2/2]

bool HPS::LineKey::ShowPointsByList	(	size_t	in_count,
		size_t const	in_indices[],
		PointArray &	out_points
	)		const

Show a subset of the points for this LineKey by list.

Parameters

in_count	The number of points to show.
in_indices	The list of point indices to show.
out_points	The requested points for this LineKey.

Returns

true if all requested points were set, false otherwise.

ShowPointsByRange()

bool HPS::LineKey::ShowPointsByRange	(	size_t	in_start_index,
		size_t	in_count,
		PointArray &	out_points
	)		const

Show a subset of the points for this LineKey by range.

Parameters

in_start_index	The first point to show.
in_count	The number of points to show.
out_points	The requested points for this LineKey.

Returns

true if all requested points 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.

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.

UnsetPointCoordinateSpace() [1/3]

LineKey& HPS::LineKey::UnsetPointCoordinateSpace

(

SizeTArray const &

in_indices

)

Unsets the coordinate space for specified points on this line back to Coordinate::Space::Object.

Parameters

in_indices

The list of point indices to unset.

Returns

A reference to this LineKey.

UnsetPointCoordinateSpace() [2/3]

LineKey& HPS::LineKey::UnsetPointCoordinateSpace	(	size_t	in_count,
		size_t const	in_indices[]
	)

Unsets the coordinate space for specified points on this line back to Coordinate::Space::Object.

Parameters

in_count	The number of points to unset.
in_indices	The list of point indices to unset.

Returns

A reference to this LineKey.

UnsetPointCoordinateSpace() [3/3]

LineKey& HPS::LineKey::UnsetPointCoordinateSpace

(

)

Unsets the coordinate space for all points on this line back to Coordinate::Space::Object.

Returns

A reference to this LineKey.

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

static

---

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

• hps.h