Filter
-
class Filter : public HPS::Component
The Filter class is a smart pointer. It represents a filter, i.e., a collection of visibility settings for a CADModel.
Subclassed by HPS::Exchange::Filter
Public Functions
-
void Activate(View const &in_view)
Activates this Filter on a given View. The View must have an attached CADModel which this Filter belongs to, otherwise an exception will be thrown.
-
void Deactivate(View const &in_view)
Dectivates this Filter on a given View. The View must have this Filter activated on it, otherwise an exception will be thrown.
-
Filter()
The default constructor creates an uninitialized Filter object. The Type() function will return Type::None.
-
Filter(Component const &in_that)
This constructor creates a Filter object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of a Filter object. Otherwise the copy will fail and the resulting Filter will be invalid.
- Parameters:
in_that – The source Component to copy.
-
Filter(Filter &&in_that)
The move constructor creates a Filter by transferring the underlying object of the rvalue reference to this Filter.
- Parameters:
in_that – An rvalue reference to a Filter to take the underlying object from.
-
Filter(Filter const &in_that)
The copy constructor creates a Filter object that shares the underlying smart-pointer of the source Filter.
- Parameters:
in_that – The source Filter to copy.
-
inline virtual HPS::Type ObjectType() const
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.
-
Filter &operator=(Filter &&in_that)
The move assignment operator transfers the underlying object of the rvalue reference to this Filter.
-
virtual ~Filter()
-
void Activate(View const &in_view)