#include <hps.h>
Public Member Functions | |
ColorInterpolationControl (SegmentKey &in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
ColorInterpolationControl (ColorInterpolationControl const &in_that) | |
Initializes a control tied to the same object as in_that. More... | |
ColorInterpolationControl (ColorInterpolationControl &&in_that) | |
The move constructor creates a ColorInterpolationControl by transferring the underlying impl of the rvalue reference to this ColorInterpolationControl thereby avoiding a copy and allocation. More... | |
ColorInterpolationControl & | operator= (ColorInterpolationControl &&in_that) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ColorInterpolationControl thereby avoiding a copy. More... | |
~ColorInterpolationControl () | |
Releases a reference to the database object this control is tied to. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. More... | |
HPS::Type | ObjectType () const |
ColorInterpolationControl & | operator= (ColorInterpolationControl const &in_that) |
Share the underlying smart-pointer of the ColorInterpolationControl source. More... | |
ColorInterpolationControl & | SetFaceColor (bool in_state) |
Controls whether face colors will be interpolated. More... | |
ColorInterpolationControl & | SetEdgeColor (bool in_state) |
Controls whether edge colors will be interpolated. More... | |
ColorInterpolationControl & | SetVertexColor (bool in_state) |
Controls whether vertex colors will be interpolated. More... | |
ColorInterpolationControl & | SetFaceIndex (bool in_state) |
Controls whether face colors index will be interpolated. More... | |
ColorInterpolationControl & | SetEdgeIndex (bool in_state) |
Controls whether edge index colors will be interpolated. More... | |
ColorInterpolationControl & | SetVertexIndex (bool in_state) |
Controls whether vertex index colors will be interpolated. More... | |
ColorInterpolationControl & | UnsetFaceColor () |
Removes the face color interpolation setting. More... | |
ColorInterpolationControl & | UnsetEdgeColor () |
Removes the edge color interpolation setting. More... | |
ColorInterpolationControl & | UnsetVertexColor () |
Removes the vertex color interpolation setting. More... | |
ColorInterpolationControl & | UnsetFaceIndex () |
Removes the face index color interpolation setting. More... | |
ColorInterpolationControl & | UnsetEdgeIndex () |
Removes the edge index color interpolation setting. More... | |
ColorInterpolationControl & | UnsetVertexIndex () |
Removes the vertex index color interpolation setting. More... | |
ColorInterpolationControl & | UnsetEverything () |
Unsets all settings in this control. More... | |
bool | ShowFaceColor (bool &out_state) const |
Shows whether color interpolation for the face color is set. More... | |
bool | ShowEdgeColor (bool &out_state) const |
Shows whether color interpolation for the edge color is set. More... | |
bool | ShowVertexColor (bool &out_state) const |
Shows whether color interpolation for the vertex color is set. More... | |
bool | ShowFaceIndex (bool &out_state) const |
Shows whether color index interpolation for the face index is set. More... | |
bool | ShowEdgeIndex (bool &out_state) const |
Shows whether color index interpolation for the edge index is set. More... | |
bool | ShowVertexIndex (bool &out_state) const |
Shows whether color index interpolation for the vertex index is set. 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::ColorInterpolationControl |
Private Member Functions | |
ColorInterpolationControl () | |
Private default constructor to prevent instantiation without a segment. More... | |
The HPS::ColorInterpolationControl class is a smart pointer that is tied to a database object. This class is the interface that allows you to manipulate whether color is interpolated over faces and edges. This table lists default values for the various segment attributes accessible from HPS::ColorInterpolationControl.
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::ColorInterpolationControl::ColorInterpolationControl | ( | ColorInterpolationControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::ColorInterpolationControl::ColorInterpolationControl | ( | ColorInterpolationControl && | in_that | ) |
The move constructor creates a ColorInterpolationControl by transferring the underlying impl of the rvalue reference to this ColorInterpolationControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a ColorInterpolationControl to take the impl from. |
HPS::ColorInterpolationControl::~ColorInterpolationControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlineprivate |
Private default constructor to prevent instantiation without a segment.
|
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.
|
inlinevirtualinherited |
Indicates whether this object has any values set on it.
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.
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
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.
|
inherited |
|
inlinevirtual |
Reimplemented from HPS::Control.
ColorInterpolationControl& HPS::ColorInterpolationControl::operator= | ( | ColorInterpolationControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ColorInterpolationControl thereby avoiding a copy.
in_that | An rvalue reference to a ColorInterpolationControl to take the impl from. |
ColorInterpolationControl& HPS::ColorInterpolationControl::operator= | ( | ColorInterpolationControl const & | in_that | ) |
Share the underlying smart-pointer of the ColorInterpolationControl source.
in_that | The ColorInterpolationControl source of the assignment. |
|
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.
ColorInterpolationControl& HPS::ColorInterpolationControl::SetEdgeColor | ( | bool | in_state | ) |
Controls whether edge colors will be interpolated.
in_state | Whether edge colors will be interpolated. |
ColorInterpolationControl& HPS::ColorInterpolationControl::SetEdgeIndex | ( | bool | in_state | ) |
Controls whether edge index colors will be interpolated.
in_state | Whether edge index colors will be interpolated. |
ColorInterpolationControl& HPS::ColorInterpolationControl::SetFaceColor | ( | bool | in_state | ) |
Controls whether face colors will be interpolated.
in_state | Whether face colors will be interpolated. |
ColorInterpolationControl& HPS::ColorInterpolationControl::SetFaceIndex | ( | bool | in_state | ) |
Controls whether face colors index will be interpolated.
in_state | Whether face index colors will be interpolated. |
ColorInterpolationControl& HPS::ColorInterpolationControl::SetVertexColor | ( | bool | in_state | ) |
Controls whether vertex colors will be interpolated.
in_state | Whether vertex colors will be interpolated. |
ColorInterpolationControl& HPS::ColorInterpolationControl::SetVertexIndex | ( | bool | in_state | ) |
Controls whether vertex index colors will be interpolated.
in_state | Whether vertex index colors will be interpolated. |
bool HPS::ColorInterpolationControl::ShowEdgeColor | ( | bool & | out_state | ) | const |
Shows whether color interpolation for the edge color is set.
out_state | The edge setting for the color interpolation |
bool HPS::ColorInterpolationControl::ShowEdgeIndex | ( | bool & | out_state | ) | const |
Shows whether color index interpolation for the edge index is set.
out_state | The edge setting for the color index interpolation |
bool HPS::ColorInterpolationControl::ShowFaceColor | ( | bool & | out_state | ) | const |
Shows whether color interpolation for the face color is set.
out_state | The face setting for the color interpolation |
bool HPS::ColorInterpolationControl::ShowFaceIndex | ( | bool & | out_state | ) | const |
Shows whether color index interpolation for the face index is set.
out_state | The face setting for the color index interpolation |
bool HPS::ColorInterpolationControl::ShowVertexColor | ( | bool & | out_state | ) | const |
Shows whether color interpolation for the vertex color is set.
out_state | The vertex setting for the color interpolation |
bool HPS::ColorInterpolationControl::ShowVertexIndex | ( | bool & | out_state | ) | const |
Shows whether color index interpolation for the vertex index is set.
out_state | The vertex setting for the color index interpolation |
|
inlinevirtual |
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.
Reimplemented from HPS::Control.
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEdgeColor | ( | ) |
Removes the edge color interpolation setting.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by ColorInterpolationKit::GetDefault().
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEdgeIndex | ( | ) |
Removes the edge index color interpolation setting.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by ColorInterpolationKit::GetDefault().
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetEverything | ( | ) |
Unsets all settings in this control.
If the control is attached to a WindowKey this function restores the default settings of this control as specified by ColorInterpolationKit::GetDefault().
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetFaceColor | ( | ) |
Removes the face color interpolation setting.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by ColorInterpolationKit::GetDefault().
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetFaceIndex | ( | ) |
Removes the face index color interpolation setting.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by ColorInterpolationKit::GetDefault().
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetVertexColor | ( | ) |
Removes the vertex color interpolation setting.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by ColorInterpolationKit::GetDefault().
ColorInterpolationControl& HPS::ColorInterpolationControl::UnsetVertexIndex | ( | ) |
Removes the vertex index color interpolation setting.
If the control is attached to a WindowKey this function restores the default value of this setting as specified by ColorInterpolationKit::GetDefault().
|
static |