All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VisualizationBase Class CAT3DCustomRep

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---VisualizationBase.CATRep
        |
        +---VisualizationBase.CAT3DRep
          |
          +---CAT3DCustomRep
 

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


public class CAT3DCustomRep

Class to manage a collection of graphic primitives with different graphic attributes.


Constructor and Destructor Index


o CAT3DCustomRep()
Contructs an empty custom representation.
o CAT3DCustomRep(CATGraphicPrimitive*,CATGraphicAttributeSet&)
Contructs a custom representation with one graphic primitive.
o ~CAT3DCustomRep()

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 GetGP(int)
Returns a graphic primitive from the list of managed graphic primitives.
o GetGPSize()
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 SetPickMode(unsigned int)
Sets the pick mode of the representation.

Constructor and Destructor


o CAT3DCustomRep
public CAT3DCustomRep()
Contructs an empty custom representation.
o CAT3DCustomRep
public CAT3DCustomRep(CATGraphicPrimitive* iGraphicPrimitive,
const CATGraphicAttributeSet& iGraphicAttribut)
Contructs a custom representation with one graphic primitive.
Parameters:
iGraphicPrimitive
Do not delete this graphic primitive.
iGraphicAttribut
The graphic attributes of iGraphicPrimitive.
o ~CAT3DCustomRep
public virtual ~CAT3DCustomRep()

Methods


o AddGP
public virtual void AddGP(CATGraphicPrimitive* iGraphicPrimitive,
const CATGraphicAttributeSet& iGraphicAttribut)
Adds a graphic primitive to the list of managed graphic primitives.
Parameters:
iGraphicPrimitive
Do not delete this graphic primitive.
iGraphicAttribut
The graphic attributes of iGraphicPrimitive.
o GetAttribut
public virtual CATGraphicAttributeSet & GetAttribut( const int iIndex) const
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].
o GetGP
public virtual CATGraphicPrimitive * GetGP( const int iIndex) const
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 int GetGPSize()const
Returns the number of managed graphic primitives.
o Modify
public virtual void Modify(CATGraphicPrimitive* iOldGraphicPrimitive,
CATGraphicPrimitive* iNewGraphicPrimitive,
CATGraphicAttributeSet* 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 void RemoveGP(CATGraphicPrimitive* iGraphicPrimitive)
Removes a graphic primitive from the list of managed graphic primitives.
Parameters:
iGraphicPrimitive
The caller must delete the graphic primitive.
o SetPickMode
public virtual void SetPickMode(unsigned int iPickMode)
Sets the pick mode of the representation.
Role: the pick mode is propagated to the enclosed graphical primitives.
Parameters:
iPickMode
  1. 0 : representation is pickable
  2. 1 : representation is not pickable

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

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