OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    IVtkTools_DisplayModeFilter Class Reference

    Cells filter according to the selected display mode by mesh parts types. This filter is used to get parts of a shape according to different display modes. More...

    #include <IVtkTools_DisplayModeFilter.hxx>

    Inheritance diagram for IVtkTools_DisplayModeFilter:

    Public Member Functions

     vtkTypeMacro (IVtkTools_DisplayModeFilter, IVtkTools_SubPolyDataFilter) static IVtkTools_DisplayModeFilter *New()
    void PrintSelf (std::ostream &os, vtkIndent indent) override
    void SetDisplayMode (const IVtk_DisplayMode aMode)
     Set display mode to define cells types to be passed through this filter.
    void SetDisplaySharedVertices (const bool doDisplay)
     Display or not shared vertices.
    IVtk_DisplayMode GetDisplayMode () const
     Get current display mode.
    const NCollection_Map< IVtk_IdType > & MeshTypesForMode (IVtk_DisplayMode theMode) const
     Returns list of displaying mesh element types for the given display mode.
    void SetMeshTypesForMode (IVtk_DisplayMode theMode, const NCollection_Map< IVtk_IdType > &theMeshTypes)
     Set a list of displaying mesh element types for the given display mode.
    void SetFaceBoundaryDraw (bool theToDraw)
     Draw Boundary of faces for shading mode.
    bool FaceBoundaryDraw () const
     Returns True if drawing Boundary of faces for shading mode is defined.
    bool IsSmoothShading () const
     Returns TRUE if vertex normals should be included for smooth shading within DM_Shading mode or not.
    void SetSmoothShading (bool theIsSmooth)
     Set if vertex normals should be included for smooth shading or not.
    Public Member Functions inherited from IVtkTools_SubPolyDataFilter
     vtkTypeMacro (IVtkTools_SubPolyDataFilter, vtkPolyDataAlgorithm) static IVtkTools_SubPolyDataFilter *New()
    void PrintSelf (std::ostream &theOs, vtkIndent theIndent) override
    void SetData (const NCollection_Map< IVtk_IdType > &theSet)
     Set ids to be passed through this filter.
    void AddData (const NCollection_Map< IVtk_IdType > &theSet)
     Add ids to be passed through this filter.
    void SetData (const NCollection_List< IVtk_IdType > &theIds)
     Set ids to be passed through this filter.
    void AddData (const NCollection_List< IVtk_IdType > &theIds)
     Add ids to be passed through this filter.
    void Clear ()
     Clear ids set to be passed through this filter.
    void SetIdsArrayName (const char *theArrayName)
     Set ids array name.
    void SetDoFiltering (const bool theDoFiltering)

    Protected Member Functions

    int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
     Filter cells according to the given set of ids.
     IVtkTools_DisplayModeFilter ()
     ~IVtkTools_DisplayModeFilter () override
    Protected Member Functions inherited from IVtkTools_SubPolyDataFilter
    int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
     Filter cells according to the given set of ids. Note: Data arrays are not passed through if filtering is turned on.
     IVtkTools_SubPolyDataFilter ()
     ~IVtkTools_SubPolyDataFilter () override

    Protected Attributes

    IVtk_DisplayMode myDisplayMode
     Display mode defining mesh types to pass through this filter.
    NCollection_Map< IVtk_IdTypemyModesDefinition [2]
    bool myDoDisplaySharedVertices
    bool myDrawFaceBoundaries
     Draw Face boundaries within shading display mode.
    bool myIsSmoothShading
     include vertex normals for smooth shading or not
    Protected Attributes inherited from IVtkTools_SubPolyDataFilter
    NCollection_Map< IVtk_IdTypemyIdsSet
     Set of ids to be passed through this filter.
    const char * myIdsArrayName
    bool myDoFiltering
    bool myToCopyNormals

    Detailed Description

    Cells filter according to the selected display mode by mesh parts types. This filter is used to get parts of a shape according to different display modes.

    Constructor & Destructor Documentation

    ◆ IVtkTools_DisplayModeFilter()

    IVtkTools_DisplayModeFilter::IVtkTools_DisplayModeFilter ( )
    protected

    ◆ ~IVtkTools_DisplayModeFilter()

    IVtkTools_DisplayModeFilter::~IVtkTools_DisplayModeFilter ( )
    overrideprotected

    Member Function Documentation

    ◆ FaceBoundaryDraw()

    bool IVtkTools_DisplayModeFilter::FaceBoundaryDraw ( ) const
    inline

    Returns True if drawing Boundary of faces for shading mode is defined.

    ◆ GetDisplayMode()

    IVtk_DisplayMode IVtkTools_DisplayModeFilter::GetDisplayMode ( ) const

    Get current display mode.

    ◆ IsSmoothShading()

    bool IVtkTools_DisplayModeFilter::IsSmoothShading ( ) const
    inline

    Returns TRUE if vertex normals should be included for smooth shading within DM_Shading mode or not.

    ◆ MeshTypesForMode()

    const NCollection_Map< IVtk_IdType > & IVtkTools_DisplayModeFilter::MeshTypesForMode ( IVtk_DisplayMode theMode) const

    Returns list of displaying mesh element types for the given display mode.

    ◆ PrintSelf()

    void IVtkTools_DisplayModeFilter::PrintSelf ( std::ostream & os,
    vtkIndent indent )
    override

    ◆ RequestData()

    int IVtkTools_DisplayModeFilter::RequestData ( vtkInformation * ,
    vtkInformationVector ** ,
    vtkInformationVector *  )
    overrideprotected

    Filter cells according to the given set of ids.

    ◆ SetDisplayMode()

    void IVtkTools_DisplayModeFilter::SetDisplayMode ( const IVtk_DisplayMode aMode)

    Set display mode to define cells types to be passed through this filter.

    ◆ SetDisplaySharedVertices()

    void IVtkTools_DisplayModeFilter::SetDisplaySharedVertices ( const bool doDisplay)

    Display or not shared vertices.

    ◆ SetFaceBoundaryDraw()

    void IVtkTools_DisplayModeFilter::SetFaceBoundaryDraw ( bool theToDraw)

    Draw Boundary of faces for shading mode.

    ◆ SetMeshTypesForMode()

    void IVtkTools_DisplayModeFilter::SetMeshTypesForMode ( IVtk_DisplayMode theMode,
    const NCollection_Map< IVtk_IdType > & theMeshTypes )

    Set a list of displaying mesh element types for the given display mode.

    ◆ SetSmoothShading()

    void IVtkTools_DisplayModeFilter::SetSmoothShading ( bool theIsSmooth)

    Set if vertex normals should be included for smooth shading or not.

    ◆ vtkTypeMacro()

    IVtkTools_DisplayModeFilter::vtkTypeMacro ( IVtkTools_DisplayModeFilter ,
    IVtkTools_SubPolyDataFilter  )

    Field Documentation

    ◆ myDisplayMode

    IVtk_DisplayMode IVtkTools_DisplayModeFilter::myDisplayMode
    protected

    Display mode defining mesh types to pass through this filter.

    ◆ myDoDisplaySharedVertices

    bool IVtkTools_DisplayModeFilter::myDoDisplaySharedVertices
    protected

    ◆ myDrawFaceBoundaries

    bool IVtkTools_DisplayModeFilter::myDrawFaceBoundaries
    protected

    Draw Face boundaries within shading display mode.

    ◆ myIsSmoothShading

    bool IVtkTools_DisplayModeFilter::myIsSmoothShading
    protected

    include vertex normals for smooth shading or not

    ◆ myModesDefinition

    NCollection_Map<IVtk_IdType> IVtkTools_DisplayModeFilter::myModesDefinition[2]
    protected

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