Inheritance diagram for HPS.Filter:
HPS.Component HPS.Sprocket HPS.Object HPS.Exchange.Filter

Public Member Functions

void Activate (HPS.View in_view)
void Deactivate (HPS.View in_view)
override void Dispose ()
 Filter ()
 Filter (HPS.Component in_that)
 Filter (HPS.Filter in_that)
override HPS.Type ObjectType ()
- Public Member Functions inherited from HPS.Component
void AddKey (HPS.Key in_key)
void AddOwner (HPS.Component in_owner, HPS.IncludeKey in_include)
void AddOwner (HPS.Component in_owner)
void AddReference (HPS.Component in_reference)
bool AddTransform (HPS.MatrixKit in_transform)
virtual void Assign (HPS.Component in_that)
 Component ()
 Component (HPS.Component in_that)
HPS.Component CopyTo (HPS.Component in_new_owner)
void Delete (HPS.Component.DeleteMode mode)
void Delete ()
override bool Equals (System.Object obj)
bool Equals (HPS.Component in_that)
void Flush ()
HPS.Metadata [] GetAllMetadata ()
HPS.Component [] GetAllSubcomponents (HPS.Component.ComponentType in_type)
HPS.Component.ComponentType GetComponentType ()
override int GetHashCode ()
HPS.Key [] GetKeys ()
HPS.Metadata GetMetadata (string in_name)
string GetName ()
HPS.Component [] GetOwners ()
HPS.Component [] GetReferences ()
HPS.Component [] GetReferrers ()
HPS.Component [] GetSubcomponents ()
bool HasComponentType (HPS.Component.ComponentType in_mask)
bool SetName (string in_new_name)
bool SetTransform (HPS.MatrixKit in_transform)
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 Sprocket (HPS.Sprocket in_that)
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
IntPtr GetClassID ()
IntPtr GetInstanceID ()
bool HasType (HPS.Type in_mask)
 Object (HPS.Object that)
virtual void Reset ()
virtual HPS.Type Type ()

Protected Member Functions

override void deleteCptr ()
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()

Additional Inherited Members

- Public Types inherited from HPS.Component
enum  ComponentType : uint {
  None = 0x00000000, GenericMask = 0xFFFFF000, ComponentType.ExchangeComponentMask = 0x00001000, ComponentType.ExchangeModelFile = 0x00001001,
  ComponentType.ExchangeProductOccurrence = 0x00001002, ComponentType.ExchangePartDefinition = 0x00001003, ComponentType.ExchangeView = 0x00001004, ComponentType.ExchangeFilter = 0x00001005,
  ComponentType.ExchangeRepresentationItemMask = 0x00003000, ComponentType.ExchangeRIBRepModel = 0x00003001, ComponentType.ExchangeRICurve = 0x00003002, ComponentType.ExchangeRIDirection = 0x00003003,
  ComponentType.ExchangeRIPlane = 0x00003004, ComponentType.ExchangeRIPointSet = 0x00003005, ComponentType.ExchangeRIPolyBRepModel = 0x00003006, ComponentType.ExchangeRIPolyWire = 0x00003007,
  ComponentType.ExchangeRISet = 0x00003008, ComponentType.ExchangeRICoordinateSystem = 0x00003009, ComponentType.ExchangeTopologyMask = 0x00005000, ComponentType.ExchangeTopoBody = 0x00005001,
  ComponentType.ExchangeTopoConnex = 0x00005002, ComponentType.ExchangeTopoShell = 0x00005003, ComponentType.ExchangeTopoFace = 0x00005004, ComponentType.ExchangeTopoLoop = 0x00005005,
  ComponentType.ExchangeTopoCoEdge = 0x00005006, ComponentType.ExchangeTopoEdge = 0x00005007, ComponentType.ExchangeTopoVertex = 0x00005008, ComponentType.ExchangeTopoSingleWireBody = 0x00005009,
  ComponentType.ExchangeTopoWireEdge = 0x0000500A, ComponentType.ExchangeDrawingMask = 0x00009000, ComponentType.ExchangeDrawingModel = 0x00009001, ComponentType.ExchangeDrawingView = 0x00009002,
  ComponentType.ExchangeDrawingSheet = 0x00009003, ComponentType.ExchangeBasicDrawingBlock = 0x00009004, ComponentType.ExchangeOperatorDrawingBlock = 0x00009005, ComponentType.ExchangePMIMask = 0x00011000,
  ComponentType.ExchangePMI = 0x00011000, ComponentType.ExchangePMIText = 0x00011100, ComponentType.ExchangePMIRichText = 0x00011200, ComponentType.ExchangePMIRoughness = 0x00011300,
  ComponentType.ExchangePMIGDT = 0x00011400, ComponentType.ExchangePMIDatum = 0x00011500, ComponentType.ExchangePMILineWelding = 0x00011600, ComponentType.ExchangePMISpotWelding = 0x00011700,
  ComponentType.ExchangePMIDimension = 0x00011800, ComponentType.ExchangePMIBalloon = 0x00011900, ComponentType.ExchangePMICoordinate = 0x00011A00, ComponentType.ExchangePMIFastener = 0x00011B00,
  ComponentType.ExchangePMILocator = 0x00011C00, ComponentType.ExchangePMIMeasurementPoint = 0x00011D00, ComponentType.ParasolidComponentMask = 0x00020000, ComponentType.ParasolidModelFile = 0x00020001,
  ComponentType.ParasolidAssembly = 0x00020002, ComponentType.ParasolidInstance = 0x00020003, ComponentType.ParasolidTopologyMask = 0x00060000, ComponentType.ParasolidTopoBody = 0x00060001,
  ComponentType.ParasolidTopoRegion = 0x00060002, ComponentType.ParasolidTopoShell = 0x00060003, ComponentType.ParasolidTopoFace = 0x00060004, ComponentType.ParasolidTopoLoop = 0x00060005,
  ComponentType.ParasolidTopoFin = 0x00060006, ComponentType.ParasolidTopoEdge = 0x00060007, ComponentType.ParasolidTopoVertex = 0x00060008, ComponentType.DWGComponentMask = 0x00100000,
  ComponentType.DWGModelFile = 0x00100001, ComponentType.DWGLayout = 0x00100002, ComponentType.DWGBlockTable = 0x00100003, ComponentType.DWGBlockTableRecord = 0x00100004,
  ComponentType.DWGEntity = 0x00100005, ComponentType.DWGLayerTable = 0x00100006, ComponentType.DWGLayer = 0x00100007, ComponentType.UserComponent = 0x01000000

enum  DeleteMode { Standard = 0, Full = 1, StandardAndExchange = 2 }
- Static Public Member Functions inherited from HPS.Component
static HPS.KeyPath [] GetKeyPath (HPS.Component in_component)
static HPS.KeyPath [] GetKeyPath (HPS.Component[] in_components)
static bool operator!= (HPS.Component a, HPS.Component b)
static bool operator== (HPS.Component a, HPS.Component b)
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
- Protected Attributes inherited from HPS.Object
bool cMemOwn
HandleRef cptr

Detailed Description

The Filter class is a smart pointer. It represents a filter, i.e., a collection of visibility settings for a CADModel.

Constructor & Destructor Documentation

◆ Filter() [1/3]

HPS.Filter.Filter ( )

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

◆ Filter() [2/3]

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

in_thatThe source Component to copy.

◆ Filter() [3/3]

HPS.Filter.Filter ( HPS.Filter  in_that)

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

in_thatThe source Filter to copy.

Member Function Documentation

◆ Activate()

void HPS.Filter.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.

in_viewThe View on which to activate this Filter.

◆ Deactivate()

void HPS.Filter.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.

in_viewThe View on which to deactivate this Filter.

◆ ObjectType()

override HPS.Type HPS.Filter.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).

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

Reimplemented from HPS.Component.

Reimplemented in HPS.Exchange.Filter.

The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.Filter.cs