VisualizationFoundation CAT2DCustomRep
Usage: you must use this class as is. You should never derive it.
public class CAT2DCustomRep
Class to manage a collection of 2D graphic primitives with different graphic attributes.
Role:
The primitives that are being added to the representation are not copied
within it. The graphical attributes are copied inside the representation.
Constructor and Destructor Index
- o
CAT2DCustomRep(void)
- Contructs an empty 2D custom representation.
- o
CAT2DCustomRep(CATGraphicPrimitive*,CATGraphicAttributeSet&)
- Contructs a 2D custom representation with one graphic primitive.
- o
~CAT2DCustomRep(void)
-
Method Index
- o
AddGP(CATGraphicPrimitive*,CATGraphicAttributeSet&)
- Adds a graphic primitive to the list of managed graphic primitives.
- o
GetAttribut(int)
- Returns the graphic attributes associated with a managed graphic primitive.
- o
GetAttribut(int,CATGraphicAttributeSet&)
- Returns the graphic attributes associated with a managed graphic primitive.
- o
GetGP(int)
- Returns a graphic primitive from the list of managed graphic primitives.
- o
GetGPSize(void)
- Returns the number of managed graphic primitives.
- o
Modify(CATGraphicPrimitive*,CATGraphicPrimitive*,CATGraphicAttributeSet*)
- Replaces a graphic primitive in the list of managed graphic primitives.
- o
RemoveGP(CATGraphicPrimitive*)
- Removes a graphic primitive from the list of managed graphic primitives.
- o
SetAttribut(int,CATGraphicAttributeSet const&)
- Set the graphic attributes associated with a managed graphic primitive.
Constructor and Destructor
o CAT2DCustomRep
-
Contructs an empty 2D custom representation.
o CAT2DCustomRep
| public CAT2DCustomRep( | | iGraphicPrimitive, |
| const | iGraphicAttribut) |
-
Contructs a 2D custom representation with one graphic primitive.
- Parameters:
-
- iGraphicPrimitive
- The primitive
(It is not copied inside the representation).
- iGraphicAttribut
- The graphic attributes of iGraphicPrimitive.
o ~CAT2DCustomRep
| public virtual ~CAT2DCustomRep( | | ) |
-
Methods
o AddGP
| public virtual AddGP( | | iGraphicPrimitive, |
| const | iGraphicAttribut) |
-
Adds a graphic primitive to the list of managed graphic primitives.
- Parameters:
-
- iGraphicPrimitive
- The primitive to be added.
(It is not copied inside the representation).
- iGraphicAttribut
- The graphic attributes of iGraphicPrimitive.
o GetAttribut
| public virtual GetAttribut( | const | iIndex) |
-
Returns the graphic attributes associated with a managed graphic primitive. Do not delete the returned graphic primitive.
- Parameters:
-
- iIndex
- Index value in the list of managed graphic primitives.
Legal values are [0,GetGPSize()-1].
- Deprecated:
- R216
use void GetAttribut(const int iIndex,CATGraphicAttributeSet& oGAS) or void SetAttribut(const int iIndex,CATGraphicAttributeSet const& iGAS) methods instead
o GetAttribut
| public virtual GetAttribut( | const | iIndex, |
| | oGAS) |
-
Returns the graphic attributes associated with a managed graphic primitive.
- Parameters:
-
- iIndex
- Index value in the list of managed graphic primitives.
Legal values are [0,GetGPSize()-1].
- oGAS
- Reference to a CATGraphicAttributeSet that will hold the result
o GetGP
| public virtual GetGP( | const | iIndex) |
-
Returns a graphic primitive from the list of managed graphic primitives.
- Parameters:
-
- iIndex
- Index value in the list of managed graphic primitives.
Legal values are [0,GetGPSize()-1].
o GetGPSize
| public virtual GetGPSize( | | ) |
-
Returns the number of managed graphic primitives.
o Modify
| public virtual Modify( | | iOldGraphicPrimitive, |
| | iNewGraphicPrimitive, |
| | iNewGraphicAttribut) |
-
Replaces a graphic primitive in the list of managed graphic primitives.
- Parameters:
-
- iOldGraphicPrimitive
- The graphic primitive to be removed.
The caller must delete the graphic primitive.
- iNewGraphicPrimitive
- The graphic primitive to be inserted.
The caller must not delete the graphic primitive.
- iNewGraphicAttribut
- The graphic attributes of iNewGraphicAttribut.
If NULL, the graphic attributes of iOldGraphicPrimitive are kept unchanged.
If not, the caller must delete the the graphic attributes.
o RemoveGP
| public virtual RemoveGP( | | iGraphicPrimitive) |
-
Removes a graphic primitive from the list of managed graphic primitives.
- Parameters:
-
- iGraphicPrimitive
- The primitive to be removed. The caller must delete the graphic primitive.
o SetAttribut
| public virtual SetAttribut( | const | iIndex, |
| | iGAS) |
-
Set the graphic attributes associated with a managed graphic primitive.
- Parameters:
-
- iIndex
- Index value in the list of managed graphic primitives.
Legal values are [0,GetGPSize()-1].
- iGAS
- Reference to a CATGraphicAttributeSet
This object is included in the file: CAT2DCustomRep.h
If needed, your Imakefile.mk should include the module: CATVisFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.