All Frameworks  Class Hierarchy  This Framework  Indexes   

PolyhedralInterfaces Interface CATIPolySurface

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIPolySurface

Interface to a polyhedral surface.
A polyhedral surface is a surface represented by vertices, facets, layers and support. It consists of: o Iterators to cycle through the vertices and facets. o Layers that store some properties about the vertices, facets or the surface. o Neighborhoods that provide the links between the vertices and the facets. o A surface support that provide additional information about the geometry of the surface. The discrete data (vertices and facets) are referenced by integer indices.


Method Index


o Accept(CATIPolySurface&,CATPolySurfaceVisitor&)
Access the concrete surface type through a visitor.
o Accept(CATIPolySurface&,CATPolySurfaceConstVisitor&)
Access the concrete surface type through a const visitor.
o AddVertex(int&)
Add a vertex to the surface.
o CastToTriMesh()
Cast a CATIPolySurface to a CATIPolyMesh.
o CastToTriMesh()
Cast a const CATIPolySurface to a const CATIPolyMesh.
o CastToTriQuadMesh()
Cast a CATIPolySurface to a CATIPolyTriQuadMesh.
o CastToTriQuadMesh()
Cast a const CATIPolySurface to a const CATIPolyTriQuadMesh.
o GetFacetIterator(CATIPolySurfaceFacetIterator*&)
Return a facet iterator.
o GetMaxFacetSize()
Return the maximal number of vertices a facet can have in this surface.
o GetNbFacets()
Return the number of facets (Explicit).
o GetNbVertices()
Return the number of vertices of the polyhedral surface.
o GetOrientedBarTangentLayer(CATIPolySurfaceOrientedBarTangentLayer*&)
Return the oriented bar tangent layer if any.
o GetOrientedBarTangentLayer(CATIPolySurfaceOrientedBarTangentConstLayer*&)
Return the oriented bar tangent layer if any.
o GetSupport(CATIPolySurfaceSupport*&)
Return the underlying surface support, if any.
o GetVertexCellLayer(CATIPolySurfaceVertexCellLayer*&)
Return the vertex (macro) cell layer if any.
o GetVertexCellLayer(CATIPolySurfaceVertexCellConstLayer*&)
Return the vertex (macro) cell layer if any.
o GetVertexFacetNeighborhood(CATIPolySurfaceVertexFacetNeighborhood*&)
Return the vertex facet neighborhood.
o GetVertexIterator(CATIPolySurfaceVertexIterator*&)
Return a vertex iterator (explicit).
o GetVertexNormalLayer(CATIPolySurfaceVertexNormalLayer*&)
Return the vertex normal layer if any.
o GetVertexNormalLayer(CATIPolySurfaceVertexNormalConstLayer*&)
Return the vertex normal layer if any.
o GetVertexPositionLayer(CATIPolySurfaceVertexPositionLayer*&)
Return the vertex position layer if any.
o GetVertexPositionLayer(CATIPolySurfaceVertexPositionConstLayer*&)
Return the vertex position layer if any.
o GetVertexTextureCoordLayer(CATIPolySurfaceVertexTextureCoordLayer*&)
Return the vertex texture coordinate layer if any.
o GetVertexTextureCoordLayer(CATIPolySurfaceVertexTextureCoordConstLayer*&)
Return the vertex texture coordinate layer if any.
o GetVertexUVLayer(CATIPolySurfaceVertexUVLayer*&)
Return the vertex UV layer if any.
o GetVertexUVLayer(CATIPolySurfaceVertexUVConstLayer*&)
Return the vertex UV layer if any.
o SetSupport(CATIPolySurfaceSupport*)
Set the underlying surface support.

Methods


o Accept
public virtual Accept( iS,
iV)
Access the concrete surface type through a visitor.
Returns:
The status of the application of the visitor.
o Accept
public virtual Accept( const iS,
iV)
Access the concrete surface type through a const visitor.
Returns:
The status of the application of the visitor.
o AddVertex
public virtual AddVertex( v)
Add a vertex to the surface.
Parameters:
v
The index of the added vertex.
Returns:
S_OK on success or E_FAIL or another error otherwise.
o CastToTriMesh
public virtual CastToTriMesh()
Cast a CATIPolySurface to a CATIPolyMesh.
Returns:
The cast as a CATIPolyMesh.
o CastToTriMesh
public virtual CastToTriMesh()
Cast a const CATIPolySurface to a const CATIPolyMesh.
Returns:
The cast as a const CATIPolyMesh.
o CastToTriQuadMesh
public virtual CastToTriQuadMesh()
Cast a CATIPolySurface to a CATIPolyTriQuadMesh.
Returns:
The cast as a CATIPolyTriQuadMesh.
o CastToTriQuadMesh
public virtual CastToTriQuadMesh()
Cast a const CATIPolySurface to a const CATIPolyTriQuadMesh.
Returns:
The cast as a const CATIPolyTriQuadMesh.
o GetFacetIterator
public virtual GetFacetIterator( oIterator)
Return a facet iterator.
Parameters:
oIterator
The output iterator. The returned instance must be released. (ref-counted.)
Returns:
S_OK on success and E_FAIL or another error otherwise.
o GetMaxFacetSize
public virtual GetMaxFacetSize()
Return the maximal number of vertices a facet can have in this surface.
Returns:
The maximum number of vertices per facet allowed.
o GetNbFacets
public virtual GetNbFacets()
Return the number of facets (Explicit).
Returns:
The number of facets.
o GetNbVertices
public virtual GetNbVertices()
Return the number of vertices of the polyhedral surface.
Returns:
The number of vertices of the discrete surface.
o GetOrientedBarTangentLayer
public virtual GetOrientedBarTangentLayer( oLayer)
Return the oriented bar tangent layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetOrientedBarTangentLayer
public virtual GetOrientedBarTangentLayer( oLayer)
Return the oriented bar tangent layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetSupport
public virtual GetSupport( oSupport)
Return the underlying surface support, if any.
Parameters:
oSupport
The surface support. The returned support must be released (ref-counted.)
Returns:
S_OK if a support is successfully returned. S_FALSE if a support is not available. E_FAIL if an error occurs.
o GetVertexCellLayer
public virtual GetVertexCellLayer( oLayer)
Return the vertex (macro) cell layer if any. This is an upward link to the macro-topology (CATPolyVertex, CATPolyEdge, CATPolyFace).
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexCellLayer
public virtual GetVertexCellLayer( oLayer)
Return the vertex (macro) cell layer if any. This is an upward link to the macro-topology (CATPolyVertex, CATPolyEdge, CATPolyFace).
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexFacetNeighborhood
public virtual GetVertexFacetNeighborhood( oNeighborhood)
Return the vertex facet neighborhood. The neighborhood layer associates to each vertex the facets that refer to it.
Parameters:
oNeighborhood
The neighborhood layer.
Returns:
S_OK if a neighborhood is available. S_FALSE if no neighborhood is available. E_FAIL or another error otherwise.
o GetVertexIterator
public virtual GetVertexIterator( oIterator)
Return a vertex iterator (explicit).
Parameters:
oIterator
The output iterator. The returned instance must be released. (ref-counted.)
Returns:
S_OK on success or E_FAIL or another error otherwise.
o GetVertexNormalLayer
public virtual GetVertexNormalLayer( oLayer)
Return the vertex normal layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexNormalLayer
public virtual GetVertexNormalLayer( oLayer)
Return the vertex normal layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexPositionLayer
public virtual GetVertexPositionLayer( oLayer)
Return the vertex position layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexPositionLayer
public virtual GetVertexPositionLayer( oLayer)
Return the vertex position layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexTextureCoordLayer
public virtual GetVertexTextureCoordLayer( oLayer)
Return the vertex texture coordinate layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexTextureCoordLayer
public virtual GetVertexTextureCoordLayer( oLayer)
Return the vertex texture coordinate layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexUVLayer
public virtual GetVertexUVLayer( oLayer)
Return the vertex UV layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o GetVertexUVLayer
public virtual GetVertexUVLayer( oLayer)
Return the vertex UV layer if any.
Parameters:
oLayer
The layer that is returned. The returned layer must be released (ref-counted.)
Returns:
S_OK if a layer is successfully returned. S_FALSE if a layer is not available. E_FAIL if an error occurs.
o SetSupport
public virtual SetSupport( iSupport)
Set the underlying surface support.
Parameters:
iSupport
A pointer to the surface support. The method does and AddRef () on the support. Any previous support owned by the object will be released.
Returns:
S_OK if a support is successfully set. E_FAIL otherwise.

This object is included in the file: CATIPolySurface.h
If needed, your Imakefile.mk should include the module: CATPolyhedralInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.