SHAPER  9.12.0
FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces Class Referenceabstract
Inheritance diagram for FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces:
Inheritance graph

Public Member Functions

def __init__ (self)
 
def name (self)
 
def isSupported (self, theType)
 
def isMultiple (self)
 
def isOk (self, theShape, theResult, theArgs)
 
def xmlRepresentation (self)
 
def initAttributes (self, theArgs)
 
def adjacentFaces (self, theFace, theMapSA, theShapeType, theApplicableFaces, theRecursive=True)
 
virtual const std::string & name () const =0
 Returns name of the filter to represent it in GUI. More...
 
virtual bool isSupported (GeomAPI_Shape::ShapeType theType) const =0
 Returns true if the given shape type is supported. More...
 
virtual bool isOk (const GeomShapePtr &theShape, const ResultPtr &theResult, const ModelAPI_FiltersArgs &theArgs) const =0
 This method should contain the filter logic. More...
 
virtual bool isMultiple () const
 Returns True if the filter can be used several times within one filtering. More...
 
virtual std::string xmlRepresentation () const
 Returns XML string which represents GUI of the filter By default it returns nothing (no GUI) More...
 
virtual void initAttributes (ModelAPI_FiltersArgs &)
 Initializes arguments of a filter. More...
 
virtual std::string xmlFromFile (const std::string &theConfigFile) const
 Returns XML string which represents GUI of the filter by reading corresponding XML file. More...
 

Data Fields

 myCached
 

Detailed Description

Filter for faces topologically connected to the selected object.

Constructor & Destructor Documentation

◆ __init__()

def FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces.__init__ (   self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Member Function Documentation

◆ name() [1/2]

def FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces.name (   self)
 Description of the filter 

◆ isSupported() [1/2]

def FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces.isSupported (   self,
  theType 
)
 Supported types of filtered shapes 

◆ isMultiple() [1/2]

def FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces.isMultiple (   self)
 Returns True if the filter can be used several times within one selection 

◆ isOk() [1/2]

def FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces.isOk (   self,
  theShape,
  theResult,
  theArgs 
)
 True if theShape is applicable for the filter 

◆ xmlRepresentation() [1/2]

def FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces.xmlRepresentation (   self)
 Returns XML string which represents GUI of the filter 

◆ initAttributes() [1/2]

def FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces.initAttributes (   self,
  theArgs 
)
 Initializes arguments of a filter 

◆ adjacentFaces()

def FiltersPlugin_TopoConnectedFaces.FiltersPlugin_TopoConnectedFaces.adjacentFaces (   self,
  theFace,
  theMapSA,
  theShapeType,
  theApplicableFaces,
  theRecursive = True 
)
 Find all faces neighbour to theFace 

◆ name() [2/2]

◆ isSupported() [2/2]

◆ isOk() [2/2]

virtual bool ModelAPI_Filter::isOk ( const GeomShapePtr &  theShape,
const ResultPtr &  theResult,
const ModelAPI_FiltersArgs theArgs 
) const
pure virtualinherited

This method should contain the filter logic.

It returns true if the given shape is accepted by the filter.

Parameters
theShapethe given shape
theResultparent result of the shape to be checked
theArgsarguments of the filter

Implemented in FiltersPlugin_OnShapeName, FiltersPlugin_ExternalFaces, FiltersPlugin_VolumeSize, FiltersPlugin_VerticalFace, FiltersPlugin_RelativeToSolid, FiltersPlugin_OppositeToEdge, FiltersPlugin_OnPlaneSide, FiltersPlugin_OnPlane, FiltersPlugin_OnLine, FiltersPlugin_OnGeometry, FiltersPlugin_HorizontalFace, FiltersPlugin_FeatureEdges, FiltersPlugin_FaceSize, FiltersPlugin_EdgeSize, FiltersPlugin_ContinuousFaces, and FiltersPlugin_BelongsTo.

◆ isMultiple() [2/2]

virtual bool ModelAPI_Filter::isMultiple ( ) const
inlinevirtualinherited

Returns True if the filter can be used several times within one filtering.

Reimplemented in FiltersPlugin_RelativeToSolid, FiltersPlugin_OnPlaneSide, FiltersPlugin_OnPlane, and FiltersPlugin_OnLine.

◆ xmlRepresentation() [2/2]

virtual std::string ModelAPI_Filter::xmlRepresentation ( ) const
inlinevirtualinherited

◆ initAttributes() [2/2]

◆ xmlFromFile()

std::string ModelAPI_Filter::xmlFromFile ( const std::string &  theConfigFile) const
virtualinherited

Returns XML string which represents GUI of the filter by reading corresponding XML file.