Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::InfiniteLineGlyphElement Class Reference

The InfiniteLineGlyphElement class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::InfiniteLineGlyphElement:
Collaboration diagram for HPS::InfiniteLineGlyphElement:

Public Member Functions

 InfiniteLineGlyphElement ()
 The default constructor creates an empty InfiniteLineGlyphElement object. More...
 
 InfiniteLineGlyphElement (GlyphElement const &in_that)
 This constructor creates a InfiniteLineGlyphElement object that contains the same settings as the source GlyphElement. More...
 
 InfiniteLineGlyphElement (InfiniteLineGlyphElement const &in_that)
 The copy constructor creates a new InfiniteLineGlyphElement object that contains the same settings as the source InfiniteLineGlyphElement. More...
 
 InfiniteLineGlyphElement (GlyphPoint const &in_first, GlyphPoint const &in_second, InfiniteLine::Type in_type=InfiniteLine::Type::Line)
 This constructor creates a InfiniteLineGlyphElement with the specified vector and type. More...
 
 InfiniteLineGlyphElement (InfiniteLineGlyphElement &&in_that)
 The move constructor creates an InfiniteLineGlyphElement by transferring the underlying impl of the rvalue reference to this InfiniteLineGlyphElement thereby avoiding a copy and allocation. More...
 
InfiniteLineGlyphElementoperator= (InfiniteLineGlyphElement &&in_that)
 The move assignment operator transfers the underlying impl of the rvalue reference to this InfiniteLineGlyphElement thereby avoiding a copy. More...
 
 ~InfiniteLineGlyphElement ()
 
HPS::Type ObjectType () const
 
void SetFirstPoint (GlyphPoint const &in_point)
 Sets the first point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
void SetSecondPoint (GlyphPoint const &in_point)
 Sets the second point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
void SetPoints (GlyphPoint const &in_first, GlyphPoint const &in_second)
 Sets the points for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
void SetInfiniteType (InfiniteLine::Type in_type)
 Sets the type of this InfiniteLineGlyphElement, i.e., whether it represents an infinite line or ray. More...
 
bool ShowFirstPoint (GlyphPoint &out_point) const
 Shows the first point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
bool ShowSecondPoint (GlyphPoint &out_point) const
 Shows the second point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
bool ShowInfiniteType (InfiniteLine::Type &out_type) const
 Shows the type of this InfiniteLineGlyphElement. More...
 
void Set (GlyphElement const &in_that)
 Copies the source GlyphElement into this GlyphElement. More...
 
bool Equals (GlyphElement const &in_that) const
 Check if the source GlyphElement is equivalent to this GlyphElement. More...
 
bool operator== (GlyphElement const &in_that) const
 Check if the source GlyphElement is equivalent to this GlyphElement. More...
 
bool operator!= (GlyphElement const &in_that) const
 Check if the source GlyphElement is not equivalent to this GlyphElement. More...
 
void SetFill (Glyph::Fill in_fill)
 Sets the fill mode for this GlyphElement. More...
 
void SetIndexedColor (byte in_index)
 Sets the color index for this GlyphElement. More...
 
void SetNormalColor ()
 Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph. More...
 
void SetExplicitColor (RGBAColor const &in_color)
 Sets the RGBA color for this GlyphElement. More...
 
bool ShowFill (Glyph::Fill &out_fill) const
 Shows the fill mode for this GlyphElement. More...
 
bool ShowColor (Glyph::ColorSource &out_source, byte &out_index, RGBAColor &out_color) const
 Shows the color for this GlyphElement. 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::InfiniteLineGlyphElement
 

Detailed Description

The InfiniteLineGlyphElement class is a user space object.

It is used to add infinite line and ray elements to a glyph.

Constructor & Destructor Documentation

◆ InfiniteLineGlyphElement() [1/5]

HPS::InfiniteLineGlyphElement::InfiniteLineGlyphElement ( )

The default constructor creates an empty InfiniteLineGlyphElement object.

◆ InfiniteLineGlyphElement() [2/5]

HPS::InfiniteLineGlyphElement::InfiniteLineGlyphElement ( GlyphElement const &  in_that)

This constructor creates a InfiniteLineGlyphElement object that contains the same settings as the source GlyphElement.

The copy will only be successful if the source glyph element is really an upcast of an infinite line glyph element. Otherwise the copy will fail and the resulting InfiniteLineGlyphElement will be invalid.

Parameters
in_thatThe source GlyphElement to copy.

◆ InfiniteLineGlyphElement() [3/5]

HPS::InfiniteLineGlyphElement::InfiniteLineGlyphElement ( InfiniteLineGlyphElement const &  in_that)

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

Parameters
in_thatThe source InfiniteLineGlyphElement to copy.

◆ InfiniteLineGlyphElement() [4/5]

HPS::InfiniteLineGlyphElement::InfiniteLineGlyphElement ( GlyphPoint const &  in_first,
GlyphPoint const &  in_second,
InfiniteLine::Type  in_type = InfiniteLine::Type::Line 
)

This constructor creates a InfiniteLineGlyphElement with the specified vector and type.

Parameters
in_firstThe first point along the InfiniteLineGlyphElement
in_secondThe second point along the InfiniteLineGlyphElement
in_typeThe type of infinite line - either Ray or Line

◆ InfiniteLineGlyphElement() [5/5]

HPS::InfiniteLineGlyphElement::InfiniteLineGlyphElement ( InfiniteLineGlyphElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to an InfiniteLineGlyphElement to take the impl from.

◆ ~InfiniteLineGlyphElement()

HPS::InfiniteLineGlyphElement::~InfiniteLineGlyphElement ( )

Member Function Documentation

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

◆ 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::GlyphElement::Equals ( GlyphElement const &  in_that) const
inherited

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters
in_thatThe source GlyphElement to compare to this GlyphElement.
Returns
true if the objects are equivalent, false otherwise.

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

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

◆ HasType()

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

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

Parameters
in_maskThe Type mask to check against this Object.
Returns
true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::InfiniteLineGlyphElement::ObjectType ( ) const
inlinevirtual

Reimplemented from HPS::GlyphElement.

◆ operator!=()

bool HPS::GlyphElement::operator!= ( GlyphElement const &  in_that) const
inherited

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

Parameters
in_thatThe source GlyphElement to compare to this GlyphElement.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=()

InfiniteLineGlyphElement& HPS::InfiniteLineGlyphElement::operator= ( InfiniteLineGlyphElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to an InfiniteLineGlyphElement to take the impl from.
Returns
A reference to this InfiniteLineGlyphElement.

◆ operator==()

bool HPS::GlyphElement::operator== ( GlyphElement const &  in_that) const
inherited

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters
in_thatThe source GlyphElement to compare to this GlyphElement.
Returns
true if the objects are equivalent, false otherwise.

◆ Reset()

◆ Set()

void HPS::GlyphElement::Set ( GlyphElement const &  in_that)
inherited

Copies the source GlyphElement into this GlyphElement.

Parameters
in_thatThe source GlyphElement to copy.

◆ SetExplicitColor()

void HPS::GlyphElement::SetExplicitColor ( RGBAColor const &  in_color)
inherited

Sets the RGBA color for this GlyphElement.

Parameters
in_colorThe color for this GlyphElement.

◆ SetFill()

void HPS::GlyphElement::SetFill ( Glyph::Fill  in_fill)
inherited

Sets the fill mode for this GlyphElement.

Parameters
in_fillThe fill mode for this GlyphElement.

◆ SetFirstPoint()

void HPS::InfiniteLineGlyphElement::SetFirstPoint ( GlyphPoint const &  in_point)

Sets the first point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
in_pointThe first point for the vector defining the infinite line or ray.

◆ SetIndexedColor()

void HPS::GlyphElement::SetIndexedColor ( byte  in_index)
inherited

Sets the color index for this GlyphElement.

Parameters
in_indexThe color index for this GlyphElement.

◆ SetInfiniteType()

void HPS::InfiniteLineGlyphElement::SetInfiniteType ( InfiniteLine::Type  in_type)

Sets the type of this InfiniteLineGlyphElement, i.e., whether it represents an infinite line or ray.

Parameters
in_typeThe type of this InfiniteLineGlyphElement.

◆ SetNormalColor()

void HPS::GlyphElement::SetNormalColor ( )
inherited

Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph.

◆ SetPoints()

void HPS::InfiniteLineGlyphElement::SetPoints ( GlyphPoint const &  in_first,
GlyphPoint const &  in_second 
)

Sets the points for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
in_firstThe first point for the vector defining the infinite line or ray.
in_secondThe second point for the vector defining the infinite line or ray.

◆ SetSecondPoint()

void HPS::InfiniteLineGlyphElement::SetSecondPoint ( GlyphPoint const &  in_point)

Sets the second point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
in_pointThe second point for the vector defining the infinite line or ray.

◆ ShowColor()

bool HPS::GlyphElement::ShowColor ( Glyph::ColorSource out_source,
byte out_index,
RGBAColor out_color 
) const
inherited

Shows the color for this GlyphElement.

Parameters
out_sourceThe color source for this GlyphElement.
out_indexThe color index for this GlyphElement. This is only valid if out_source is Glyph::ColorSource::Indexed.
out_colorThe color for this GlyphElement. This is only valid if out_source is Glyph::ColorSource::Explicit.
Returns
true if a color was set, false otherwise.

◆ ShowFill()

bool HPS::GlyphElement::ShowFill ( Glyph::Fill out_fill) const
inherited

Shows the fill mode for this GlyphElement.

Parameters
out_fillThe fill mode for this GlyphElement.
Returns
true if a fill mode was set, false otherwise.

◆ ShowFirstPoint()

bool HPS::InfiniteLineGlyphElement::ShowFirstPoint ( GlyphPoint out_point) const

Shows the first point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
out_pointThe first point for the vector defining the infinite line or ray.
Returns
true if a first point was set, false otherwise.

◆ ShowInfiniteType()

bool HPS::InfiniteLineGlyphElement::ShowInfiniteType ( InfiniteLine::Type out_type) const

Shows the type of this InfiniteLineGlyphElement.

Parameters
out_typeThe type of this InfiniteLineGlyphElement.
Returns
true if a type was set, false otherwise.

◆ ShowSecondPoint()

bool HPS::InfiniteLineGlyphElement::ShowSecondPoint ( GlyphPoint out_point) const

Shows the second point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
out_pointThe second point for the vector defining the infinite line or ray.
Returns
true if a second point was set, false otherwise.

◆ Type()

Member Data Documentation

◆ staticType

const HPS::Type HPS::InfiniteLineGlyphElement::staticType = HPS::Type::InfiniteLineGlyphElement
static

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