HPS::CylinderKey Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::CylinderKey:

Collaboration diagram for HPS::CylinderKey:

Public Member Functions
	CylinderKey ()
	The default constructor creates an uninitialized CylinderKey object. More...
	CylinderKey (Key const &in_that)
	This constructor creates a CylinderKey object that shares the underlying smart-pointer of the source Key. More...
	CylinderKey (CylinderKey const &in_that)
	The copy constructor creates a CylinderKey object that shares the underlying smart-pointer of the source CylinderKey. More...
CylinderKey &	operator= (CylinderKey const &in_that)
	Associate this CylinderKey with the same underlying impl as the source CylinderKey. More...
	CylinderKey (CylinderKey &&in_that)
	The move constructor creates a CylinderKey by transferring the underlying impl of the rvalue reference to this CylinderKey thereby avoiding a copy and allocation. More...
CylinderKey &	operator= (CylinderKey &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CylinderKey thereby avoiding a copy. More...
	~CylinderKey ()
HPS::Type	ObjectType () const
void	Consume (CylinderKit &in_kit)
	Completely replaces all settings on this CylinderKey with those set on the specified kit and resets the kit. More...
void	Set (CylinderKit const &in_kit)
	Replace those settings on this CylinderKey with those set on the specified kit. More...
CylinderKey &	EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[])
	Adds points to the point list for this CylinderKey. More...
CylinderKey &	EditPointsByInsertion (size_t in_offset, PointArray const &in_points)
	Adds points to the point list for this CylinderKey. More...
CylinderKey &	EditPointsByDeletion (size_t in_offset, size_t in_count)
	Removes points from the point list for this CylinderKey. More...
CylinderKey &	EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[])
	Replaces points in the point list for this CylinderKey. More...
CylinderKey &	EditPointsByReplacement (size_t in_offset, PointArray const &in_points)
	Replaces points in the point list for this CylinderKey. More...
CylinderKey &	EditRadiiByInsertion (size_t in_offset, size_t in_count, float const in_radii[])
	Adds radii to the radius list for this CylinderKey. More...
CylinderKey &	EditRadiiByInsertion (size_t in_offset, FloatArray const &in_radii)
	Adds radii to the radius list for this CylinderKey. More...
CylinderKey &	EditRadiiByDeletion (size_t in_offset, size_t in_count)
	Removes radii from the radius list for this CylinderKey. More...
CylinderKey &	EditRadiiByReplacement (size_t in_offset, size_t in_count, float const in_radii[])
	Replaces radii in the radius list for this CylinderKey. More...
CylinderKey &	EditRadiiByReplacement (size_t in_offset, FloatArray const &in_radii)
	Replaces radii in the radius list for this CylinderKey. More...
void	Show (CylinderKit &out_kit) const
	Copy the contents of this CylinderKey into the specified kit. More...
size_t	GetPointCount () const
	Retrieves the number of points in this cylinder. More...
bool	ShowPoints (PointArray &out_points) const
	Show the points for this CylinderKey. More...
bool	ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const
	Show a subset of the points for this CylinderKey by range. More...
bool	ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const
	Show a subset of the points for this CylinderKey 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 CylinderKey by list. More...
bool	ShowRadii (FloatArray &out_radii) const
	Show the radii for this CylinderKey. More...
bool	ShowCaps (Cylinder::Capping &out_caps) const
	Show the capping for this CylinderKey. More...
CylinderKey &	SetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[], Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
CylinderKey &	SetVertexRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
CylinderKey &	SetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
CylinderKey &	SetVertexIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[], Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
CylinderKey &	SetVertexIndexColorsByRange (size_t in_start, FloatArray const &in_indices, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
CylinderKey &	SetVertexIndexColorsByRange (size_t in_start, size_t in_count, float in_index, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
CylinderKey &	SetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const in_rgb_colors[], Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More...
CylinderKey &	SetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColorArray const &in_rgb_colors, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More...
CylinderKey &	SetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const &in_rgb_color, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More...
CylinderKey &	SetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColor const &in_rgb_color, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More...
CylinderKey &	SetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float const in_indices[], Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More...
CylinderKey &	SetVertexIndexColorsByList (SizeTArray const &in_vertices, FloatArray const &in_indices, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More...
CylinderKey &	SetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float in_index, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More...
CylinderKey &	SetVertexIndexColorsByList (SizeTArray const &in_vertices, float in_index, Cylinder::Component in_apply_to=Cylinder::Component::Faces)
	Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More...
CylinderKey &	UnsetVertexColors ()
	Removes all vertex colors (RGB colors or material indices) for all cylinder components. More...
CylinderKey &	UnsetVertexColorsByRange (size_t in_start, size_t in_count)
	Removes the specified range of vertex colors (RGB colors or material indices) for all cylinder components starting at the specified offset. More...
CylinderKey &	UnsetVertexColors (Cylinder::Component in_apply_to)
	Removes all vertex colors (RGB colors or material indices) for the specified cylinder component. More...
CylinderKey &	UnsetVertexColorsByRange (size_t in_start, size_t in_count, Cylinder::Component in_apply_to)
	Removes the specified range of vertex colors (RGB colors or material indices) for the specified cylinder component starting at the specified offset. More...
CylinderKey &	UnsetVertexColorsByList (size_t in_count, size_t const in_vertices[])
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
CylinderKey &	UnsetVertexColorsByList (SizeTArray const &in_vertices)
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
CylinderKey &	UnsetVertexColorsByList (size_t in_count, size_t const in_vertices[], Cylinder::Component in_apply_to)
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
CylinderKey &	UnsetVertexColorsByList (SizeTArray const &in_vertices, Cylinder::Component in_apply_to)
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
bool	ShowVertexColors (Cylinder::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const
	Shows all the vertex colors of the specified cylinder component. More...
bool	ShowVertexColorsByRange (size_t in_start, size_t in_count, Cylinder::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const
	Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
bool	ShowVertexColorsByList (SizeTArray const &in_vertices, Cylinder::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const
	Shows the vertex colors on a selection of arbitrary vertices which apply to the specified cylinder component. 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::CylinderKey

Detailed Description

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

It is a handle to a cylinder inserted via SegmentKey::InsertCylinder.

Constructor & Destructor Documentation

CylinderKey() [1/4]

HPS::CylinderKey::CylinderKey

(

)

The default constructor creates an uninitialized CylinderKey object.

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

CylinderKey() [2/4]

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

explicit

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

Parameters

in_key

The source Key to copy.

CylinderKey() [3/4]

HPS::CylinderKey::CylinderKey

(

CylinderKey const &

in_that

)

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

Parameters

in_that

The source CylinderKey to copy.

CylinderKey() [4/4]

HPS::CylinderKey::CylinderKey

(

CylinderKey &&

in_that

)

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

Parameters

in_that

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

~CylinderKey()

HPS::CylinderKey::~CylinderKey

(

)

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

(

CylinderKit &

in_kit

)

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

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

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

Removes points from the point list for this CylinderKey.

Parameters

in_offset	The offset into the point list for the cylinder 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 cylinder. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.

Returns

A reference to this CylinderKey.

EditPointsByInsertion() [1/2]

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

Adds points to the point list for this CylinderKey.

Parameters

in_offset	The offset into the point list for the cylinder 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 CylinderKey.

EditPointsByInsertion() [2/2]

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

Adds points to the point list for this CylinderKey.

Parameters

in_offset	The offset into the point list for the cylinder 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 CylinderKey.

EditPointsByReplacement() [1/2]

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

Replaces points in the point list for this CylinderKey.

Parameters

in_offset	The offset into the point list for the cylidner 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 CylinderKey.

EditPointsByReplacement() [2/2]

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

Replaces points in the point list for this CylinderKey.

Parameters

in_offset	The offset into the point list for the cylidner 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 CylinderKey.

EditRadiiByDeletion()

CylinderKey& HPS::CylinderKey::EditRadiiByDeletion	(	size_t	in_offset,
		size_t	in_count
	)

Removes radii from the radius list for this CylinderKey.

Parameters

in_offset	The offset into the radius list for the cylinder at which to start removing radii. This value must be such that in_offset<radius_count for deletion to succeed.
in_count	The number of radii to delete from the radius list for the cylinder. This value must be such that in_offset+in_count<=radius_count for the deletion to succeed.

Returns

A reference to this CylinderKey.

EditRadiiByInsertion() [1/2]

CylinderKey& HPS::CylinderKey::EditRadiiByInsertion	(	size_t	in_offset,
		size_t	in_count,
		float const	in_radii[]
	)

Adds radii to the radius list for this CylinderKey.

Parameters

in_offset	The offset into the radius list for the cylinder at which to insert radii. This value must be such that in_offset<radius_count for insertion to succeed.
in_count	Size of the following array.
in_radii	The radii to insert into the radius list at the specified offset.

Returns

A reference to this CylinderKey.

EditRadiiByInsertion() [2/2]

CylinderKey& HPS::CylinderKey::EditRadiiByInsertion	(	size_t	in_offset,
		FloatArray const &	in_radii
	)

Adds radii to the radius list for this CylinderKey.

Parameters

in_offset	The offset into the radius list for the cylinder at which to insert radii. This value must be such that in_offset<radius_count for insertion to succeed.
in_radii	The radii to insert into the radius list at the specified offset.

Returns

A reference to this CylinderKey.

EditRadiiByReplacement() [1/2]

CylinderKey& HPS::CylinderKey::EditRadiiByReplacement	(	size_t	in_offset,
		size_t	in_count,
		float const	in_radii[]
	)

Replaces radii in the radius list for this CylinderKey.

Parameters

in_offset	The offset into the radius list for the cylidner at which to start replacing radii. This value must be such that in_offset<radius_count for replacement to succeed.
in_count	Size of the following array. This value must be such that in_offset+in_count<=radius_count for the replacement to succeed.
in_radii	The radii to use to replace those in the radius list at the specified offset.

Returns

A reference to this CylinderKey.

EditRadiiByReplacement() [2/2]

CylinderKey& HPS::CylinderKey::EditRadiiByReplacement	(	size_t	in_offset,
		FloatArray const &	in_radii
	)

Replaces radii in the radius list for this CylinderKey.

Parameters

in_offset	The offset into the radius list for the cylidner at which to start replacing radii. This value must be such that in_offset<radius_count for replacement to succeed.
in_radii	The radii to use to replace those in the radius list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=radius_count for the replacement to succeed.

Returns

A reference to this CylinderKey.

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::CylinderKey::GetPointCount

(

)

const

Retrieves the number of points in this cylinder.

Returns

The number of points in this cylinder.

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

CylinderKey& HPS::CylinderKey::operator=

(

CylinderKey const &

in_that

)

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

Parameters

in_that

The source CylinderKey for the assignment.

Returns

A reference to this CylinderKey.

operator=() [2/2]

CylinderKey& HPS::CylinderKey::operator=

(

CylinderKey &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this CylinderKey.

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

(

CylinderKit const &

in_kit

)

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

Parameters

in_kit

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

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.

SetVertexIndexColorsByList() [1/4]

CylinderKey& HPS::CylinderKey::SetVertexIndexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		float const	in_indices[],
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters

in_count	Size of the following arrays.
in_vertices	The indices of the vertices on which to set the colors.
in_indices	The material indices to set on the vertices.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexIndexColorsByList() [2/4]

CylinderKey& HPS::CylinderKey::SetVertexIndexColorsByList	(	SizeTArray const &	in_vertices,
		FloatArray const &	in_indices,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters

in_vertices	The indices of the vertices on which to set the colors.
in_indices	The material indices to set on the vertices.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexIndexColorsByList() [3/4]

CylinderKey& HPS::CylinderKey::SetVertexIndexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		float	in_index,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters

in_count	Size of the following arrays.
in_vertices	The indices of the vertices on which to set the colors.
in_index	The material index to set on the vertices.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexIndexColorsByList() [4/4]

CylinderKey& HPS::CylinderKey::SetVertexIndexColorsByList	(	SizeTArray const &	in_vertices,
		float	in_index,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters

in_vertices	The indices of the vertices on which to set the colors.
in_index	The material index to set on the vertices.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexIndexColorsByRange() [1/3]

CylinderKey& HPS::CylinderKey::SetVertexIndexColorsByRange	(	size_t	in_start,
		size_t	in_count,
		float const	in_indices[],
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_indices	The material indices to set on the vertices for this CylinderKey.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexIndexColorsByRange() [2/3]

CylinderKey& HPS::CylinderKey::SetVertexIndexColorsByRange	(	size_t	in_start,
		FloatArray const &	in_indices,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_indices	The material indices to set on the vertices for this CylinderKey. The size of the array must be such that in_start+in_indices.size()<=point_count for the setting to succeed.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexIndexColorsByRange() [3/3]

CylinderKey& HPS::CylinderKey::SetVertexIndexColorsByRange	(	size_t	in_start,
		size_t	in_count,
		float	in_index,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_count	The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_index	The material index to set on the vertices for this CylinderKey.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexRGBColorsByList() [1/4]

CylinderKey& HPS::CylinderKey::SetVertexRGBColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		RGBColor const	in_rgb_colors[],
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters

in_count	Size of the following arrays.
in_vertices	The indices of the vertices on which to set the colors.
in_rgb_colors	The RGB colors to set on the vertices.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexRGBColorsByList() [2/4]

CylinderKey& HPS::CylinderKey::SetVertexRGBColorsByList	(	SizeTArray const &	in_vertices,
		RGBColorArray const &	in_rgb_colors,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters

in_vertices	The indices of the vertices on which to set the colors.
in_rgb_colors	The RGB colors to set on the vertices.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexRGBColorsByList() [3/4]

CylinderKey& HPS::CylinderKey::SetVertexRGBColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		RGBColor const &	in_rgb_color,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters

in_count	Size of the following arrays.
in_vertices	The indices of the vertices on which to set the colors.
in_rgb_color	The RGB color to set on the vertices.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexRGBColorsByList() [4/4]

CylinderKey& HPS::CylinderKey::SetVertexRGBColorsByList	(	SizeTArray const &	in_vertices,
		RGBColor const &	in_rgb_color,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters

in_vertices	The indices of the vertices on which to set the colors.
in_rgb_color	The RGB color to set on the vertices.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexRGBColorsByRange() [1/3]

CylinderKey& HPS::CylinderKey::SetVertexRGBColorsByRange	(	size_t	in_start,
		size_t	in_count,
		RGBColor const	in_rgb_colors[],
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_colors	The RGB colors to set on the vertices for this CylinderKey.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylilnder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexRGBColorsByRange() [2/3]

CylinderKey& HPS::CylinderKey::SetVertexRGBColorsByRange	(	size_t	in_start,
		RGBColorArray const &	in_rgb_colors,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgb_colors	The RGB colors to set on the vertices for this CylinderKey. The size of the array must be such that in_start+in_rgb_colors.size()<=point_count for the setting to succeed.
in_apply_to	The shell component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

SetVertexRGBColorsByRange() [3/3]

CylinderKey& HPS::CylinderKey::SetVertexRGBColorsByRange	(	size_t	in_start,
		size_t	in_count,
		RGBColor const &	in_rgb_color,
		Cylinder::Component	in_apply_to = Cylinder::Component::Faces
	)

Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_count	The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_color	The RGB color to set on the vertices for this CylinderKey.
in_apply_to	The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.

Returns

A reference to this CylinderKey.

Show()

void HPS::CylinderKey::Show

(

CylinderKit &

out_kit

)

const

Copy the contents of this CylinderKey into the specified kit.

Parameters

out_kit

The kit to populate with the contents of this CylinderKey.

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.

ShowCaps()

bool HPS::CylinderKey::ShowCaps

(

Cylinder::Capping &

out_caps

)

const

Show the capping for this CylinderKey.

Parameters

out_caps

The capping for this CylinderKey.

Returns

true if a capping was set, false otherwise.

ShowPoints()

bool HPS::CylinderKey::ShowPoints

(

PointArray &

out_points

)

const

Show the points for this CylinderKey.

Parameters

out_points

The points for this CylinderKey.

Returns

true if points were set, false otherwise.

ShowPointsByList() [1/2]

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

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

Parameters

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

Returns

true if all requested points were set, false otherwise.

ShowPointsByList() [2/2]

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

Show a subset of the points for this CylinderKey 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 CylinderKey.

Returns

true if all requested points were set, false otherwise.

ShowPointsByRange()

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

Show a subset of the points for this CylinderKey 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 CylinderKey.

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.

ShowRadii()

bool HPS::CylinderKey::ShowRadii

(

FloatArray &

out_radii

)

const

Show the radii for this CylinderKey.

Parameters

out_radii

The radii for this CylinderKey.

Returns

true if radii were 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.

ShowVertexColors()

bool HPS::CylinderKey::ShowVertexColors	(	Cylinder::Component	in_apply_to,
		MaterialTypeArray &	out_types,
		RGBColorArray &	out_rgb_colors,
		FloatArray &	out_indices
	)		const

Shows all the vertex colors of the specified cylinder component.

Parameters

in_apply_to	The cylinder component the colors should apply to.
out_types	The types of vertex colors for each vertex. If a vertex does not have a vertex color set for the specified cylinder component, the entry in this array will be Material::Type::None.
out_rgb_colors	The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices	The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns

true if any vertex colors were shown, false otherwise.

ShowVertexColorsByList()

bool HPS::CylinderKey::ShowVertexColorsByList	(	SizeTArray const &	in_vertices,
		Cylinder::Component	in_apply_to,
		MaterialTypeArray &	out_types,
		RGBColorArray &	out_rgb_colors,
		FloatArray &	out_indices
	)		const

Shows the vertex colors on a selection of arbitrary vertices which apply to the specified cylinder component.

The order of the values in the ouput arrays is the same as the input vertex index array, i.e., the values of out_types[i], out_rgb_colors[i], and out_indices[i], correspond to the vertex at index in_vertices[i].

Parameters

in_vertices	The indices of the vertices on which to show the colors.
in_apply_to	The cylinder component the colors should apply to.
out_types	The types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material::Type::None.
out_rgb_colors	The RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices	The material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns

true if any specified vertex had a vertex color on the specified component set, false otherwise.

ShowVertexColorsByRange()

bool HPS::CylinderKey::ShowVertexColorsByRange	(	size_t	in_start,
		size_t	in_count,
		Cylinder::Component	in_apply_to,
		MaterialTypeArray &	out_types,
		RGBColorArray &	out_rgb_colors,
		FloatArray &	out_indices
	)		const

Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start showing colors. This value must be such that in_start<point_count for showing to succeed.
in_count	The number of colors to show. This value must be such that in_start+in_count<=point_count for showing to succeed.
in_apply_to	The cylinder component the colors should apply to.
out_types	The types of vertex colors for each vertex in the specified range. If a vertex in the specified range does not have a vertex color set for the specified cylinder component, the entry in this array will be Material::Type::None.
out_rgb_colors	The RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices	The material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns

true if any vertex in the specified range had a vertex color on the specified component 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.

UnsetVertexColors() [1/2]

CylinderKey& HPS::CylinderKey::UnsetVertexColors

(

)

Removes all vertex colors (RGB colors or material indices) for all cylinder components.

Returns

A reference to this CylinderKey.

UnsetVertexColors() [2/2]

CylinderKey& HPS::CylinderKey::UnsetVertexColors

(

Cylinder::Component

in_apply_to

)

Removes all vertex colors (RGB colors or material indices) for the specified cylinder component.

Parameters

in_apply_to

The cylinder component for which to remove the colors.

Returns

A reference to this CylinderKey.

UnsetVertexColorsByList() [1/4]

CylinderKey& HPS::CylinderKey::UnsetVertexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[]
	)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_count	The number of vertex visibilities to remove for this CylinderKey.
in_vertices	The indices of the vertices on which to remove the visibilities.

Returns

A reference to this CylinderKey.

UnsetVertexColorsByList() [2/4]

CylinderKey& HPS::CylinderKey::UnsetVertexColorsByList

(

SizeTArray const &

in_vertices

)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_vertices

The indices of the vertices on which to remove the visibilities.

Returns

A reference to this CylinderKey.

UnsetVertexColorsByList() [3/4]

CylinderKey& HPS::CylinderKey::UnsetVertexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		Cylinder::Component	in_apply_to
	)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_count	The number of vertex visibilities to remove for this CylinderKey.
in_vertices	The indices of the vertices on which to remove the visibilities.
in_apply_to	The cylinder component that should be unset.

Returns

A reference to this CylinderKey.

UnsetVertexColorsByList() [4/4]

CylinderKey& HPS::CylinderKey::UnsetVertexColorsByList	(	SizeTArray const &	in_vertices,
		Cylinder::Component	in_apply_to
	)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_count	The number of vertex visibilities to remove for this CylinderKey.
in_vertices	The indices of the vertices on which to remove the visibilities.
in_apply_to	The cylinder component that should be unset.

Returns

A reference to this CylinderKey.

UnsetVertexColorsByRange() [1/2]

CylinderKey& HPS::CylinderKey::UnsetVertexColorsByRange	(	size_t	in_start,
		size_t	in_count
	)

Removes the specified range of vertex colors (RGB colors or material indices) for all cylinder components starting at the specified offset.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start removing colors. This value must be such that in_start<point_count for unsetting to succeed.
in_count	The number of vertex colors to remove for this CylinderKey. This value must be such that in_start+in_count<=point_count for unsetting to succeed.

Returns

A reference to this CylinderKey.

UnsetVertexColorsByRange() [2/2]

CylinderKey& HPS::CylinderKey::UnsetVertexColorsByRange	(	size_t	in_start,
		size_t	in_count,
		Cylinder::Component	in_apply_to
	)

Removes the specified range of vertex colors (RGB colors or material indices) for the specified cylinder component starting at the specified offset.

Parameters

in_start	The offset into the vertices for this CylinderKey at which to start removing colors. This value must be such that in_start<point_count for unsetting to succeed.
in_count	The number of vertex colors to remove for this CylinderKey. This value must be such that in_start+in_count<=point_count for unsetting to succeed.
in_apply_to	The cylinder component for which to remove the colors.

Returns

A reference to this CylinderKey.

Up()

SegmentKey HPS::Key::Up ( ) const

inherited

Returns

The segment containing this key.

Member Data Documentation

staticType

const HPS::Type HPS::CylinderKey::staticType = HPS::Type::CylinderKey

static

---

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

• hps.h