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
    VrmlData_IndexedFaceSet Class Reference

    #include <VrmlData_IndexedFaceSet.hxx>

    Inheritance diagram for VrmlData_IndexedFaceSet:

    Public Member Functions

     VrmlData_IndexedFaceSet ()
     VrmlData_IndexedFaceSet (const VrmlData_Scene &theScene, const char *theName, const bool isCCW=true, const bool isSolid=true, const bool isConvex=true, const double theCreaseAngle=0.)
    const occ::handle< VrmlData_Normal > & Normals () const
    const occ::handle< VrmlData_Color > & Colors () const
    const occ::handle< VrmlData_TextureCoordinate > & TextureCoords () const
    const occ::handle< VrmlData_Coordinate > & Coordinates () const
    size_t Polygons (const int **&arrPolygons) const
    int Polygon (const int iFace, const int *&outIndice)
    void SetCoordinates (const occ::handle< VrmlData_Coordinate > &theCoord)
    void SetPolygons (const size_t nPolygons, const int **thePolygons)
    size_t ArrayNormalInd (const int **&arrNormalInd) const
    int IndiceNormals (const int iFace, const int *&outIndice)
    gp_XYZ GetNormal (const int iFace, const int iVertex)
    void SetNormalInd (const size_t nIndice, const int **theIndice)
    void SetNormals (const occ::handle< VrmlData_Normal > &theNormals)
    void SetNormalPerVertex (const bool isNormalPerVertex)
    size_t ArrayColorInd (const int **&arrColorInd) const
    Quantity_Color GetColor (const int iFace, const int iVertex)
    void SetColorInd (const size_t nIndice, const int **theIndice)
    void SetColors (const occ::handle< VrmlData_Color > &theColors)
    void SetColorPerVertex (const bool isColorPerVertex)
    size_t ArrayTextureCoordInd (const int **&arrTextureCoordInd) const
    void SetTextureCoordInd (const size_t nIndice, const int **theIndice)
    void SetTextureCoords (const occ::handle< VrmlData_TextureCoordinate > &tctc)
    const occ::handle< TopoDS_TShape > & TShape () override
    occ::handle< VrmlData_NodeClone (const occ::handle< VrmlData_Node > &theOther) const override
    VrmlData_ErrorStatus Read (VrmlData_InBuffer &theBuffer) override
    VrmlData_ErrorStatus Write (const char *thePrefix) const override
    bool IsDefault () const override
    Public Member Functions inherited from VrmlData_Faceted
     VrmlData_Faceted ()
     VrmlData_Faceted (const VrmlData_Scene &theScene, const char *theName, const bool isCCW, const bool isSolid, const bool isConvex, const double theCreaseAngle)
    bool IsCCW () const
    bool IsSolid () const
    bool IsConvex () const
    double CreaseAngle () const
    void SetCCW (const bool theValue)
    void SetSolid (const bool theValue)
    void SetConvex (const bool theValue)
    void SetCreaseAngle (const double theValue)
    Public Member Functions inherited from VrmlData_Geometry
     VrmlData_Geometry ()
     VrmlData_Geometry (const VrmlData_Scene &theScene, const char *theName)
    Public Member Functions inherited from VrmlData_Node
     VrmlData_Node ()
     ~VrmlData_Node () override=default
    const VrmlData_SceneScene () const
    const char * Name () const
    VrmlData_ErrorStatus ReadNode (VrmlData_InBuffer &theBuffer, occ::handle< VrmlData_Node > &theNode, const occ::handle< Standard_Type > &Type=nullptr)
    VrmlData_ErrorStatus WriteClosing () const
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_TransientThis () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Static Public Member Functions inherited from VrmlData_Node
    static VrmlData_ErrorStatus ReadBoolean (VrmlData_InBuffer &theBuffer, bool &theResult)
    static VrmlData_ErrorStatus ReadString (VrmlData_InBuffer &theBuffer, TCollection_AsciiString &theRes)
    static VrmlData_ErrorStatus ReadMultiString (VrmlData_InBuffer &theBuffer, NCollection_List< TCollection_AsciiString > &theRes)
    static VrmlData_ErrorStatus ReadInteger (VrmlData_InBuffer &theBuffer, long &theResult)
    static bool OK (const VrmlData_ErrorStatus theStat)
    static bool OK (VrmlData_ErrorStatus &outStat, const VrmlData_ErrorStatus theStat)
    static int GlobalIndent ()
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.
    Protected Member Functions inherited from VrmlData_Faceted
    VrmlData_ErrorStatus readData (VrmlData_InBuffer &theBuffer)
    Protected Member Functions inherited from VrmlData_Geometry
    void SetTShape (const occ::handle< TopoDS_TShape > &theTShape)
    void SetModified ()
    Protected Member Functions inherited from VrmlData_Node
     VrmlData_Node (const VrmlData_Scene &theScene, const char *theName)
    Static Protected Member Functions inherited from VrmlData_Node
    static VrmlData_ErrorStatus readBrace (VrmlData_InBuffer &theBuffer)
    Protected Attributes inherited from VrmlData_Geometry
    occ::handle< TopoDS_TShapemyTShape
    bool myIsModified

    Detailed Description

    Implementation of IndexedFaceSet node

    Constructor & Destructor Documentation

    ◆ VrmlData_IndexedFaceSet() [1/2]

    VrmlData_IndexedFaceSet::VrmlData_IndexedFaceSet ( )
    inline

    Empty constructor

    ◆ VrmlData_IndexedFaceSet() [2/2]

    VrmlData_IndexedFaceSet::VrmlData_IndexedFaceSet ( const VrmlData_Scene & theScene,
    const char * theName,
    const bool isCCW = true,
    const bool isSolid = true,
    const bool isConvex = true,
    const double theCreaseAngle = 0. )
    inline

    Constructor

    Member Function Documentation

    ◆ ArrayColorInd()

    size_t VrmlData_IndexedFaceSet::ArrayColorInd ( const int **& arrColorInd) const
    inline

    Query the array of color indice

    Parameters
    arrColorInd[out] array of colorIndex as it is described in VRML2.0 spec
    Returns
    Number of integers in the array arrColorInd.

    ◆ ArrayNormalInd()

    size_t VrmlData_IndexedFaceSet::ArrayNormalInd ( const int **& arrNormalInd) const
    inline

    Query the array of normal indice

    Parameters
    arrNormalInd[out] array of normalIndex as it is described in VRML2.0 spec
    Returns
    Number of integers in the array arrNormalInd.

    ◆ ArrayTextureCoordInd()

    size_t VrmlData_IndexedFaceSet::ArrayTextureCoordInd ( const int **& arrTextureCoordInd) const
    inline

    Query the array of texture coordinate indice

    Parameters
    arrTextureCoordInd[out] array of texCoordIndex as it is described in VRML2.0 spec
    Returns
    Number of integers in the array texCoordIndex.

    ◆ Clone()

    occ::handle< VrmlData_Node > VrmlData_IndexedFaceSet::Clone ( const occ::handle< VrmlData_Node > & theOther) const
    overridevirtual

    Create a copy of this node. If the parameter is null, a new copied node is created. Otherwise new node is not created, but rather the given one is modified.

    Reimplemented from VrmlData_Node.

    ◆ Colors()

    const occ::handle< VrmlData_Color > & VrmlData_IndexedFaceSet::Colors ( ) const
    inline

    Query the Colors.

    ◆ Coordinates()

    const occ::handle< VrmlData_Coordinate > & VrmlData_IndexedFaceSet::Coordinates ( ) const
    inline

    Query the Coordinates.

    ◆ GetColor()

    Quantity_Color VrmlData_IndexedFaceSet::GetColor ( const int iFace,
    const int iVertex )

    Query a color for one node in the given element. The color is interpreted according to fields myColors, myArrColorInd, myColorPerVertex, as defined in VRML 2.0.

    Parameters
    iFacerank of the polygon [0 .. N-1]
    iVertexrank of the vertex in the polygon [0 .. M-1]. This parameter is ignored if (myColorPerVertex == False)
    Returns
    Color value (RGB); if the color is indefinite then returns (0., 0., 0.)

    ◆ GetNormal()

    gp_XYZ VrmlData_IndexedFaceSet::GetNormal ( const int iFace,
    const int iVertex )

    Query a normal for one node in the given element. The normal is interpreted according to fields myNormals, myArrNormalInd, myNormalPerVertex, as defined in VRML 2.0.

    Parameters
    iFacerank of the polygon [0 .. N-1]
    iVertexrank of the vertex in the polygon [0 .. M-1]. This parameter is ignored if (myNormalPerVertex == False)
    Returns
    Normal vector; if the normal is indefinite then returns (0., 0., 0.)

    ◆ IndiceNormals()

    int VrmlData_IndexedFaceSet::IndiceNormals ( const int iFace,
    const int *& outIndice )
    inline

    Query normals indice for one face. This method should be called after checking myArrNormalInd != NULL, otherwise exception will be thrown.

    Parameters
    iFacerank of the face [0 .. N-1]
    outIndice[out] array of normals indice
    Returns
    number of indice in the array - the dimension of outIndice array

    ◆ IsDefault()

    bool VrmlData_IndexedFaceSet::IsDefault ( ) const
    overridevirtual

    Returns True if the node is default, so that it should not be written.

    Reimplemented from VrmlData_Node.

    ◆ Normals()

    const occ::handle< VrmlData_Normal > & VrmlData_IndexedFaceSet::Normals ( ) const
    inline

    Query the Normals.

    ◆ Polygon()

    int VrmlData_IndexedFaceSet::Polygon ( const int iFace,
    const int *& outIndice )
    inline

    Query one polygon.

    Parameters
    iFacerank of the polygon [0 .. N-1]
    outIndice[out] array of vertex indice
    Returns
    number of vertice in the polygon - the dimension of outIndice array

    ◆ Polygons()

    size_t VrmlData_IndexedFaceSet::Polygons ( const int **& arrPolygons) const
    inline

    Query the array of polygons

    ◆ Read()

    VrmlData_ErrorStatus VrmlData_IndexedFaceSet::Read ( VrmlData_InBuffer & theBuffer)
    overridevirtual

    Read the Node from input stream.

    Implements VrmlData_Node.

    ◆ SetColorInd()

    void VrmlData_IndexedFaceSet::SetColorInd ( const size_t nIndice,
    const int ** theIndice )
    inline

    Set the colors array of indice

    ◆ SetColorPerVertex()

    void VrmlData_IndexedFaceSet::SetColorPerVertex ( const bool isColorPerVertex)
    inline

    Set the boolean value "colorPerVertex"

    ◆ SetColors()

    void VrmlData_IndexedFaceSet::SetColors ( const occ::handle< VrmlData_Color > & theColors)
    inline

    Set the Color node

    ◆ SetCoordinates()

    void VrmlData_IndexedFaceSet::SetCoordinates ( const occ::handle< VrmlData_Coordinate > & theCoord)
    inline

    Set the nodes

    ◆ SetNormalInd()

    void VrmlData_IndexedFaceSet::SetNormalInd ( const size_t nIndice,
    const int ** theIndice )
    inline

    Set the normals array of indice

    ◆ SetNormalPerVertex()

    void VrmlData_IndexedFaceSet::SetNormalPerVertex ( const bool isNormalPerVertex)
    inline

    Set the boolean value "normalPerVertex"

    ◆ SetNormals()

    void VrmlData_IndexedFaceSet::SetNormals ( const occ::handle< VrmlData_Normal > & theNormals)
    inline

    Set the normals node

    ◆ SetPolygons()

    void VrmlData_IndexedFaceSet::SetPolygons ( const size_t nPolygons,
    const int ** thePolygons )
    inline

    Set the polygons

    ◆ SetTextureCoordInd()

    void VrmlData_IndexedFaceSet::SetTextureCoordInd ( const size_t nIndice,
    const int ** theIndice )
    inline

    Set the TexCoordiante array of indice

    ◆ SetTextureCoords()

    void VrmlData_IndexedFaceSet::SetTextureCoords ( const occ::handle< VrmlData_TextureCoordinate > & tc)
    inline

    Set the Texture Coordinate node

    ◆ TextureCoords()

    const occ::handle< VrmlData_TextureCoordinate > & VrmlData_IndexedFaceSet::TextureCoords ( ) const
    inline

    Query the Texture Coordinates.

    ◆ TShape()

    const occ::handle< TopoDS_TShape > & VrmlData_IndexedFaceSet::TShape ( )
    overridevirtual

    Query the shape. This method checks the flag myIsModified; if True it should rebuild the shape presentation.

    Implements VrmlData_Geometry.

    ◆ Write()

    VrmlData_ErrorStatus VrmlData_IndexedFaceSet::Write ( const char * thePrefix) const
    overridevirtual

    Write the Node to output stream.

    Reimplemented from VrmlData_Node.


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