VisualizationFoundation 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()
o CAT3DCustomRep(CATGraphicPrimitive*,CATGraphicAttributeSet&)
o ~CAT3DCustomRep()

Method Index


o AddGP(CATGraphicPrimitive*,CATGraphicAttributeSet&)
Adds a graphic primitive to the list of managed graphic primitives.
o CreateRep()
Contructs an empty custom representation.
o CreateRep(CATGraphicPrimitive*,CATGraphicAttributeSet&)
Contructs a custom representation with one graphic primitive.
o Destroy()
Deletes the representation.
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()
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.
o SetPickMode(unsigned int)
Sets the pick mode of the representation.

Constructor and Destructor


o CAT3DCustomRep
public CAT3DCustomRep()
Deprecated:
R417 : Use CreateRep instead.
o CAT3DCustomRep
public CAT3DCustomRep( iGraphicPrimitive,
const iGraphicAttribut)
Deprecated:
R417 : Use CreateRep instead.
o ~CAT3DCustomRep
public virtual ~CAT3DCustomRep()

Methods


o AddGP
public virtual AddGP( iGraphicPrimitive,
const 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.
Returns:
S_OK if the GraphicPrimitive was successfully added to the Rep E_FAIL otherwise. Failure can happen if the pointer is NULL, or if the GraphicPrimitive is in edition. Warning: Show/NoShow attribute is not handled at Graphical primitive level (ie. you can not mix shown and hidden primitives). Therefore, always add shown primitives, and use the rep's graphic attribute to show/hide the entire rep.
o CreateRep
public static CreateRep()
Contructs an empty custom representation.
o CreateRep
public static CreateRep( iGraphicPrimitive,
const iGraphicAttribut)
Contructs a custom representation with one graphic primitive.
Parameters:
iGraphicPrimitive
Do not delete this graphic primitive.
iGraphicAttribut
The graphic attributes of iGraphicPrimitive. Warning: Show/NoShow attribute is not handled at Graphical primitive level (ie. you can not mix shown and hidden primitives). Therefore, always add shown primitives, and use the rep's graphic attribute to show/hide the entire rep.
o Destroy
public virtual Destroy()
Deletes the representation. Do not use the delete operator for this purpose.
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.
Returns:
S_OK if the modification was performed E_FAIL otherwise. Failure can happen if the GP pointers are NULL, or if any of the GraphicPrimitive are in edition. Warning: Show/NoShow attribute is not handled at Graphical primitive level (ie. you can not mix shown and hidden primitives). Therefore, always use shown primitives, and use the rep's graphic attribute to show/hide the entire rep.
o RemoveGP
public virtual RemoveGP( iGraphicPrimitive)
Removes a graphic primitive from the list of managed graphic primitives.
Parameters:
iGraphicPrimitive
The caller must delete the graphic primitive.
Returns:
S_OK if the GraphicPrimitive was successfully removed from the Rep E_FAIL otherwise. Failure can happen if the pointer is NULL, or if the GraphicPrimitive is in edition.
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
o SetPickMode
public virtual SetPickMode( 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: CATVisFoundation

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