Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
HPS::Control Class Reference

#include <hps.h>

Inheritance diagram for HPS::Control:
HPS::Object HPS::ApplicationWindowOptionsControl HPS::AttributeLockControl HPS::BoundingControl HPS::CameraControl HPS::ColorInterpolationControl HPS::ConditionControl HPS::ContourLineControl HPS::CullingControl HPS::CurveAttributeControl HPS::CuttingSectionAttributeControl HPS::CylinderAttributeControl HPS::DebuggingControl HPS::DrawingAttributeControl HPS::EdgeAttributeControl HPS::HiddenLineAttributeControl HPS::HighlightControl HPS::LightingAttributeControl HPS::LineAttributeControl HPS::MarkerAttributeControl HPS::MaterialMappingControl HPS::ModellingMatrixControl HPS::NURBSSurfaceAttributeControl HPS::OffScreenWindowOptionsControl HPS::PerformanceControl HPS::PortfolioControl HPS::PostProcessEffectsControl HPS::SelectabilityControl HPS::SelectionControl HPS::SelectionOptionsControl HPS::SphereAttributeControl HPS::StandAloneWindowOptionsControl HPS::StyleControl HPS::SubwindowControl HPS::TextAttributeControl HPS::TextureMatrixControl HPS::TransformMaskControl HPS::TransparencyControl HPS::UpdateOptionsControl HPS::VisibilityControl HPS::VisualEffectsControl HPS::WindowInfoControl

Public Member Functions

HPS::Type ObjectType () const
 
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Object & operator= (Object const &other_object)
 
Object & operator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Protected Member Functions

 Control (Control &&in_that)
 
Control & operator= (Control &&in_that)
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The Control class is the base class for all Visualize controls.

Constructor & Destructor Documentation

◆ Control()

HPS::Control::Control ( Control &&  in_that)
inlineprotected

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

Parameters
in_thatAn rvalue reference to a Control to take the impl from.

Member Function Documentation

◆ ObjectType()

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

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Object.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionControl, 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, and HPS::BoundingControl.

◆ operator=()

Control& HPS::Control::operator= ( Control &&  in_that)
inlineprotected

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

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

◆ Type()

virtual HPS::Type HPS::Control::Type ( ) const
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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Object.

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, and HPS::BoundingControl.

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