VisualizationFoundation CATSurfacicRep

Usage: you must use this class as is. You should never derive it.

public class CATSurfacicRep

Class to define a Surfacic representation.

Constructor and Destructor Index


o CATSurfacicRep(void)
o ~CATSurfacicRep(void)
Class destructor.

Method Index


o AddGeomElt(CATGeomType,CATGraphicPrimitive*,CATGraphicAttributeSet*)
Adds an elements of a specific geometric type to this SurfacicRep.
o AddGeomFace(CAT3DFaceGP*,CATGraphicAttributeSet*)
Adds a face to the SurfacicRep.
o CreateRep()
Class constructor.
o EditMode(void)
Retrieve the SurfacicRep's current Edit (strip) mode.
o GeomElt(CATGeomType,int)
Retrieves an elements of a specific geometric type owned by this SurfacicRep.
o GeomEltAttribut(CATGeomType,int)
o GeomFace(int)
Retrieves one of the faces owned by this SurfacicRep.
o GeomFaceAttribut(int)
o GeomNumberOfElt(CATGeomType)
Retrieves the number of elements of a specific geometric type owned by this SurfacicRep.
o GeomNumberOfFaces(void)
Retrieves the number of faces owned by this SurfacicRep.
o GetGeomEltAttribut(CATGeomType,int,CATGraphicAttributeSet&)
Retrieves the graphic attribute of an elements of a specific geometric type owned by this SurfacicRep, for read purpose.
o GetGeomFaceAttribut(int,CATGraphicAttributeSet&)
Retrieves one of the faces graphic attribute owned by this SurfacicRep for read purpose.
o GetGeomFaceMaterial(unsigned int,CATGraphicMaterial*&,unsigned int&)
o GetNormals()
Gets the normals array when edit mode = 0.
o GetNumberOfNormals()
Gets the number of normals owned by the CATSurfacicRep when it is in EditMode = 0.
o GetNumberOfVertices()
Gets the number of vertices owned by the CATSurfacicRep when it is in EditMode = 0.
o GetVertices()
Gets the vertices array when edit mode = 0.
o ReplaceGeomElt(CATGeomType,CATGraphicPrimitive*,int)
Replace an element of a specific geometric type owned by this SurfacicRep by another one.
o SetEditMode(int)
Changes the SurfacicRep's Edit (strip) mode.
o SetGeomEltAttribut(CATGeomType,int,CATGraphicAttributeSet&)
Set the graphic attribute of an elements of a specific geometric type owned by this SurfacicRep.
o SetGeomFaceAttribut(int,CATGraphicAttributeSet&)
Set the faces graphic attribute owned by this SurfacicRep.

Constructor and Destructor


o CATSurfacicRep
public CATSurfacicRep( )
Deprecated:
R417 : Use CreateRep instead.
o ~CATSurfacicRep
public ~CATSurfacicRep( )
Class destructor.

Methods


o AddGeomElt
public virtual AddGeomElt( const iType,
iGP,
iAtt=NULL)
Adds an elements of a specific geometric type to this SurfacicRep.
Parameters:
iType
A
type of element to add
iGP
The CATGraphicPrimitive to be added to the SurfacicRep. No AddRef is done on this element.
iAtt
The face's GraphicAttribute.
WARNING : Elements of type CATWireEdge, CATFreePoint and CATInfiniteFace can only have one graphic attribute for all primitives.
Returns:
S_OK if everything went fine, E_FAIL if something went wrong and E_OUTOFMEMORY if no more memory was available to allocate internal data to hold the face
If result is other than S_OK, face is Released() and iAtt is deleted
o AddGeomFace
public virtual AddGeomFace( face,
att)
Adds a face to the SurfacicRep.
Parameters:
face
The face to be added to the SurfacicRep. No AddRef is done on this element.
att
The face's GraphicAttribute
Returns:
S_OK if everything went fine, E_FAIL if something went wrong and E_OUTOFMEMORY if no more memory was available to allocate internal data to hold the face
If result is other than S_OK, face is Released() and att is deleted
o CreateRep
public static CreateRep()
Class constructor.
o EditMode
public EditMode( )
Retrieve the SurfacicRep's current Edit (strip) mode.
Returns:
1 if in exploded (unstripped) mode and 0 if in stripped mode
o GeomElt
public virtual GeomElt( const iType,
const num_elt)
Retrieves an elements of a specific geometric type owned by this SurfacicRep. All returned types should be check at runtime with IsAKindOf() method.
Parameters:
iType
A
type of element to retrieve
num_elt
The index of the element to be retrieved. Index range : 0 ->
(iType)-1
Returns:
The of type 'CATGeomType' at index 'num_elt'
o GeomEltAttribut
public virtual GeomEltAttribut( const iType,
const num_elt)
Deprecated:
V5R16 use and instead. Retrieves the graphic attribute of an elements of a specific geometric type owned by this SurfacicRep.
Parameters:
iType
A
type of element to retrieve WARNING : Elements of type CATWireEdge, CATFreePoint and CATInfiniteFace can only have one graphic attribute for all primitives.
Example :
GeomEltAttribut(CATFreePoint, 0) and GeomEltAttribut(CATFreePoint, 10) will return the same
num_elt
The index of the element to be retrieved. Index range : 0 ->
(iType)-1
Returns:
The of type 'CATGeomType' at index 'num_elt'
o GeomFace
public virtual GeomFace( const num_face)
Retrieves one of the faces owned by this SurfacicRep.
Parameters:
num_face
The index of the face to be retrieved. Index range : 0 ->
()-1
Returns:
The at index 'num_face'
o GeomFaceAttribut
public virtual GeomFaceAttribut( const num_face)
Deprecated:
V5R16 use or instead Retrieves one of the faces graphic attribute owned by this SurfacicRep.
Parameters:
num_face
The index of the face's graphic attribute to be retrieved. Index range : 0 ->
()-1
Returns:
The at index 'num_face'
o GeomNumberOfElt
public virtual GeomNumberOfElt( const iType)
Retrieves the number of elements of a specific geometric type owned by this SurfacicRep.
Parameters:
iType
A
type of element to count
Returns:
The number of elements of type owned by this surfacic rep
o GeomNumberOfFaces
public virtual GeomNumberOfFaces( )
Retrieves the number of faces owned by this SurfacicRep.
Returns:
The number of faces owned by this surfacic rep
o GetGeomEltAttribut
public virtual GetGeomEltAttribut( const iType,
const num_elt,
orGA)
Retrieves the graphic attribute of an elements of a specific geometric type owned by this SurfacicRep, for read purpose.
Parameters:
iType
A
type of element to retrieve WARNING : only Elements of type CATWireEdge, CATFreePoint and CATInfiniteFace have one graphic attribute per primitive.
Example :
GetGeomEltAttribut(CATBoundaryEdge, 0) and GetGeomEltAttribut(CATBoundaryEdge, 10) will return the same
num_elt
The index of the element to be retrieved. Index range : 0 ->
(iType)-1
orGA
The graphic attribute that is copied from the element's graphic attribute.
Returns:
S_OK if everything went fine, E_FAIL if there is no graphic attribute for this element type and index.
o GetGeomFaceAttribut
public virtual GetGeomFaceAttribut( const num_face,
orGA)
Retrieves one of the faces graphic attribute owned by this SurfacicRep for read purpose.
Parameters:
num_face
The index of the face's graphic attribute to be retrieved. Index range : 0 ->
()-1
orGA
The graphic attribute that is copied from the face's graphic attribute whose index is num_face.
Returns:
S_OK if everything went fine, E_FAIL if there is no graphic attribute for this face index.
o GetGeomFaceMaterial
public virtual GetGeomFaceMaterial( const num_face,
oMat,
oInheritance)
o GetNormals
public GetNormals()
Gets the normals array when edit mode = 0. If edit mode = 1, returned value is NULL
o GetNumberOfNormals
public GetNumberOfNormals()
Gets the number of normals owned by the CATSurfacicRep when it is in EditMode = 0. If it is in EditMode = 1, each face owns its vertices, so the returned value is 0.
o GetNumberOfVertices
public GetNumberOfVertices()
Gets the number of vertices owned by the CATSurfacicRep when it is in EditMode = 0. If it is in EditMode = 1, each face owns its vertices, so the returned value is 0.
o GetVertices
public GetVertices()
Gets the vertices array when edit mode = 0. If edit mode = 1, returned value is NULL
o ReplaceGeomElt
public virtual ReplaceGeomElt( const iType,
iNewGP,
const iInd)
Replace an element of a specific geometric type owned by this SurfacicRep by another one.
Parameters:
iType
A
type of element to retrieve
iNewGP
The CATGraphicPrimitive to substitute to the one already contained in the SurfacicRep. No AddRef is done on this element.
iInd
The index of the element to replace. Index range : 0 ->
(iType)-1
Returns:
Returns S_OK if everything went fine, E_FAIL if something went wrong and E_OUTOFMEMORY if no more memory was available to allocate internal data to hold the element.
o SetEditMode
public SetEditMode( edit_mode)
Changes the SurfacicRep's Edit (strip) mode.
Parameters:
edit_mode
The EditMode into which the surfacic rep will switch :
Legal values:
1
The SurfacicRep will switch to exploded (unstripped) mode (ie all faces will own their vertices)
0
The SurfacicRep will switch to stripped mode. In this mode the vertices are no longer owned by the faces and edges, but are merged at the SurfacicRep level.
Returns:
S_OK if everything went fine, E_FAIL otherwise
o SetGeomEltAttribut
public virtual SetGeomEltAttribut( const iType,
const num_elt,
const irGA)
Set the graphic attribute of an elements of a specific geometric type owned by this SurfacicRep.
Parameters:
iType
A
type of element to retrieve WARNING : Only Elements of type CATWireEdge, CATFreePoint and CATInfiniteFace have one graphic attribute per primitive.
Example :
SetGeomEltAttribut(CATBoundaryEdge, 0) and SetGeomEltAttribut(CATBoundaryEdge, 10) will produce the same effect.
num_elt
The index of the element to be set. Index range : 0 ->
(iType)-1 If this type has only one graphic attribut, the parameter num_elt is ignored.
irGA
The graphic attribute to set.
Returns:
S_OK if everything went fine, E_FAIL if there is no graphic attribute for this element type and index.
o SetGeomFaceAttribut
public virtual SetGeomFaceAttribut( const num_face,
const irGA)
Set the faces graphic attribute owned by this SurfacicRep. Usage : retreive a copy of the face graphic attribute using , modify the copy as you need, and call with the modified copy.
Parameters:
num_face
The index of the face's graphic attribute to be set. Index range : 0 ->
()-1
irGA
The graphic attribute to set.
Returns:
S_OK if everything went fine, E_FAIL if there is a problem.
This object is included in the file: CATSurfacicRep.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.