All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VisualizationBase Class CAT3DBagRep

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

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


public class CAT3DBagRep

Class to create a collection (bag) of representations.


Constructor and Destructor Index


o CAT3DBagRep()
Constructs an empty 3D bag representation.
o ~CAT3DBagRep()

Method Index


o AddChild(CATRep&)
Adds a child representation to the bag.
o ComputeBoundingElement(int)
Recalculates the bounding element.
o Destroy()
Deletes the bag as well as children not referenced by other bags.
o Empty()
Removes (not deletes) all the children of the bag.
o GetChildren()
Returns the list of children representations.
o GetMatrix()
Get the position and orientation of the bag.
o IsOkToDraw(CATRender&,int)
Tests whether the representation will draw its graphic primitives.
o RemoveChild(CATRep&)
Removes a child representation from the bag.
o RemoveChildren(CATRep&)
Removes a child representation from the bag.
o ResetMatrix()
Sets the matrix of the bag to the identity matrix.
o SetHighlightMode(int,int)
Sets the highlight mode of the bag.
o SetMatrix(CAT4x4Matrix&)
Sets the position and orientation of the bag.
o SetShowMode(int,int)
Sets the show mode of the bag.

Constructor and Destructor


o CAT3DBagRep
public CAT3DBagRep()
Constructs an empty 3D bag representation.
o ~CAT3DBagRep
public virtual ~CAT3DBagRep()

Methods


o AddChild
public virtual HRESULT AddChild(CATRep& iRep)
Adds a child representation to the bag.
Parameters:
iRep
Child representation to be added.
o ComputeBoundingElement
public virtual void ComputeBoundingElement(int iShowSpace=1)
Recalculates the bounding element.
Parameters:
iShowSpace
o Destroy
public virtual void Destroy()
Deletes the bag as well as children not referenced by other bags.
o Empty
public virtual void Empty()
Removes (not deletes) all the children of the bag.
o GetChildren
public list * GetChildren()
Returns the list of children representations.
o GetMatrix
public const CAT4x4Matrix * GetMatrix()const
Get the position and orientation of the bag.
Returns:
The orientation matrix of the bag.
o IsOkToDraw
public virtual int IsOkToDraw(CATRender& ioRender,
int ioInside)
Tests whether the representation will draw its graphic primitives. See CATRep::OkToDraw(CATRender & ioRender, int * ioInside)
o RemoveChild
public virtual void RemoveChild(CATRep& iRep)
Removes a child representation from the bag. The bounding element of the bag is updated.
Parameters:
iRep
Child representation to be removed.
o RemoveChildren
public virtual void RemoveChildren(CATRep& iRep)
Removes a child representation from the bag. The bounding element of the bag is not updated.
Parameters:
iRep
Child representation to be removed.
o ResetMatrix
public void ResetMatrix()
Sets the matrix of the bag to the identity matrix.
o SetHighlightMode
public virtual void SetHighlightMode(int iHighlightMode,
int iPropagationMode=0)
Sets the highlight mode of the bag.
Parameters:
iHighlightMode
    0 : bag is not highlighted
  • 1 : bag is highlighted
iPropagationMode
    0 : highlight mode is not propagated to children representations
  • 1 : highlight mode is propagated to children representations
o SetMatrix
public void SetMatrix( const CAT4x4Matrix& iMatrix)
Sets the position and orientation of the bag.
Parameters:
iMatrix
Orientation matrix of the bag.
o SetShowMode
public virtual void SetShowMode(int iShowMode,
int iPropagationMode=0)
Sets the show mode of the bag.
Parameters:
iShowMode
    0 : bag is not visible
  • 1 : bag is visible
iPropagationMode
    0 : show mode is not propagated to children representations
  • 1 : show mode is propagated to children representations

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

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