Open CASCADE Technology  7.4.1.dev
Public Member Functions
VrmlData_IndexedFaceSet Class Reference

#include <VrmlData_IndexedFaceSet.hxx>

Inheritance diagram for VrmlData_IndexedFaceSet:
Inheritance graph
[legend]

Public Member Functions

 VrmlData_IndexedFaceSet ()
 
 VrmlData_IndexedFaceSet (const VrmlData_Scene &theScene, const char *theName, const Standard_Boolean isCCW=Standard_True, const Standard_Boolean isSolid=Standard_True, const Standard_Boolean isConvex=Standard_True, const Standard_Real theCreaseAngle=0.)
 
const Handle< VrmlData_Normal > & Normals () const
 
const Handle< VrmlData_Color > & Colors () const
 
const Handle< VrmlData_TextureCoordinate > & TextureCoords () const
 
const Handle< VrmlData_Coordinate > & Coordinates () const
 
size_t Polygons (const Standard_Integer **&arrPolygons) const
 
Standard_Integer Polygon (const Standard_Integer iFace, const Standard_Integer *&outIndice)
 
void SetCoordinates (const Handle< VrmlData_Coordinate > &theCoord)
 
void SetPolygons (const Standard_Size nPolygons, const Standard_Integer **thePolygons)
 
size_t ArrayNormalInd (const Standard_Integer **&arrNormalInd) const
 
Standard_Integer IndiceNormals (const Standard_Integer iFace, const Standard_Integer *&outIndice)
 
gp_XYZ GetNormal (const Standard_Integer iFace, const Standard_Integer iVertex)
 
void SetNormalInd (const Standard_Size nIndice, const Standard_Integer **theIndice)
 
void SetNormals (const Handle< VrmlData_Normal > &theNormals)
 
void SetNormalPerVertex (const Standard_Boolean isNormalPerVertex)
 
size_t ArrayColorInd (const Standard_Integer **&arrColorInd) const
 
Quantity_Color GetColor (const Standard_Integer iFace, const Standard_Integer iVertex)
 
void SetColorInd (const Standard_Size nIndice, const Standard_Integer **theIndice)
 
void SetColors (const Handle< VrmlData_Color > &theColors)
 
void SetColorPerVertex (const Standard_Boolean isColorPerVertex)
 
size_t ArrayTextureCoordInd (const Standard_Integer **&arrTextureCoordInd) const
 
void SetTextureCoordInd (const Standard_Size nIndice, const Standard_Integer **theIndice)
 
void SetTextureCoords (const Handle< VrmlData_TextureCoordinate > &tc)
 
virtual const Handle< TopoDS_TShape > & TShape () override
 
virtual Handle< VrmlData_NodeClone (const Handle< VrmlData_Node > &theOther) const override
 
virtual VrmlData_ErrorStatus Read (VrmlData_InBuffer &theBuffer) override
 
virtual VrmlData_ErrorStatus Write (const char *thePrefix) const override
 
virtual Standard_Boolean IsDefault () const override
 
- Public Member Functions inherited from VrmlData_Faceted
 VrmlData_Faceted ()
 
 VrmlData_Faceted (const VrmlData_Scene &theScene, const char *theName, const Standard_Boolean isCCW, const Standard_Boolean isSolid, const Standard_Boolean isConvex, const Standard_Real theCreaseAngle)
 
Standard_Boolean IsCCW () const
 
Standard_Boolean IsSolid () const
 
Standard_Boolean IsConvex () const
 
Standard_Real CreaseAngle () const
 
void SetCCW (const Standard_Boolean theValue)
 
void SetSolid (const Standard_Boolean theValue)
 
void SetConvex (const Standard_Boolean theValue)
 
void SetCreaseAngle (const Standard_Real 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 ()
 
virtual ~VrmlData_Node ()
 
const VrmlData_SceneScene () const
 
const char * Name () const
 
VrmlData_ErrorStatus ReadNode (VrmlData_InBuffer &theBuffer, Handle< VrmlData_Node > &theNode, const Handle< Standard_Type > &Type=NULL)
 
VrmlData_ErrorStatus WriteClosing () const
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from VrmlData_Node
static VrmlData_ErrorStatus ReadBoolean (VrmlData_InBuffer &theBuffer, Standard_Boolean &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 Standard_Boolean OK (const VrmlData_ErrorStatus theStat)
 
static Standard_Boolean OK (VrmlData_ErrorStatus &outStat, const VrmlData_ErrorStatus theStat)
 
static Standard_Integer GlobalIndent ()
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from VrmlData_Faceted
VrmlData_ErrorStatus readData (VrmlData_InBuffer &theBuffer)
 
- Protected Member Functions inherited from VrmlData_Geometry
void SetTShape (const 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
Handle< TopoDS_TShapemyTShape
 
Standard_Boolean 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 Standard_Boolean  isCCW = Standard_True,
const Standard_Boolean  isSolid = Standard_True,
const Standard_Boolean  isConvex = Standard_True,
const Standard_Real  theCreaseAngle = 0. 
)
inline

Constructor

Member Function Documentation

◆ ArrayColorInd()

size_t VrmlData_IndexedFaceSet::ArrayColorInd ( const Standard_Integer **&  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 Standard_Integer **&  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 Standard_Integer **&  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()

virtual Handle< VrmlData_Node > VrmlData_IndexedFaceSet::Clone ( const 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 Handle< VrmlData_Color >& VrmlData_IndexedFaceSet::Colors ( ) const
inline

Query the Colors.

◆ Coordinates()

const Handle< VrmlData_Coordinate >& VrmlData_IndexedFaceSet::Coordinates ( ) const
inline

Query the Coordinates.

◆ GetColor()

Quantity_Color VrmlData_IndexedFaceSet::GetColor ( const Standard_Integer  iFace,
const Standard_Integer  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 Standard_Integer  iFace,
const Standard_Integer  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()

Standard_Integer VrmlData_IndexedFaceSet::IndiceNormals ( const Standard_Integer  iFace,
const Standard_Integer *&  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()

virtual Standard_Boolean 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 Handle< VrmlData_Normal >& VrmlData_IndexedFaceSet::Normals ( ) const
inline

Query the Normals.

◆ Polygon()

Standard_Integer VrmlData_IndexedFaceSet::Polygon ( const Standard_Integer  iFace,
const Standard_Integer *&  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 Standard_Integer **&  arrPolygons) const
inline

Query the array of polygons

◆ Read()

virtual VrmlData_ErrorStatus VrmlData_IndexedFaceSet::Read ( VrmlData_InBuffer theBuffer)
overridevirtual

Read the Node from input stream.

Implements VrmlData_Node.

◆ SetColorInd()

void VrmlData_IndexedFaceSet::SetColorInd ( const Standard_Size  nIndice,
const Standard_Integer **  theIndice 
)
inline

Set the colors array of indice

◆ SetColorPerVertex()

void VrmlData_IndexedFaceSet::SetColorPerVertex ( const Standard_Boolean  isColorPerVertex)
inline

Set the boolean value "colorPerVertex"

◆ SetColors()

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

Set the Color node

◆ SetCoordinates()

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

Set the nodes

◆ SetNormalInd()

void VrmlData_IndexedFaceSet::SetNormalInd ( const Standard_Size  nIndice,
const Standard_Integer **  theIndice 
)
inline

Set the normals array of indice

◆ SetNormalPerVertex()

void VrmlData_IndexedFaceSet::SetNormalPerVertex ( const Standard_Boolean  isNormalPerVertex)
inline

Set the boolean value "normalPerVertex"

◆ SetNormals()

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

Set the normals node

◆ SetPolygons()

void VrmlData_IndexedFaceSet::SetPolygons ( const Standard_Size  nPolygons,
const Standard_Integer **  thePolygons 
)
inline

Set the polygons

◆ SetTextureCoordInd()

void VrmlData_IndexedFaceSet::SetTextureCoordInd ( const Standard_Size  nIndice,
const Standard_Integer **  theIndice 
)
inline

Set the TexCoordiante array of indice

◆ SetTextureCoords()

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

Set the Texture Coordinate node

◆ TextureCoords()

const Handle< VrmlData_TextureCoordinate >& VrmlData_IndexedFaceSet::TextureCoords ( ) const
inline

Query the Texture Coordinates.

◆ TShape()

virtual const 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()

virtual 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: