Filter

class HPS.Filter : 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 (HPS.View 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.

Param in_view:The View on which to activate this Filter.

void Deactivate (HPS.View in_view)

Dectivates this Filter on a given View. The View must have this Filter activated on it, otherwise an exception will be thrown.

Param in_view:The View on which to deactivate this Filter.

override void Dispose ()

Filter ()

The default constructor creates an uninitialized Filter object. The Type() function will return Type.None.

Filter (HPS.Component 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.

Param in_that:The source Component to copy.

Filter (HPS.Filter in_that)

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

Param in_that:The source Filter to copy.

override HPS.Type ObjectType ()

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

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