VisualizationInterfaces CATColorPathElement

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

public class CATColorPathElement

Class representing a CATPathElement with a color.
Role : provides a particular kind of CATPathElement with a color for the highlighting

For example, if when we need to use different color for highlighting in the same time, we will use CATColorPathElement instead of CATPathElement. Actually, there are limited number of "extra" colors provided. Each of these colors are associated to a slot. The CATColorPathElement will contain this slot.

See also:

Constructor and Destructor Index


o CATColorPathElement(CATBaseUnknown*)
Constructs the class from an object.
o CATColorPathElement(CATColorPathElement&)
Copy Constructor.
o CATColorPathElement(CATPathElement&,CATColorPathElement::eSlot)
Constructs the class from a
o ~CATColorPathElement()
Copy Constructor.

Method Index


o Clone()
Returns a pointer to a new path of objects which is the clone of the current one.
o GetColorSlot()
Retrieves the color slot.
o SetColorSlot(CATColorPathElement::eSlot)
set the color slot.

Enumerated Type Index


o eSlot
Slot associated with a color.

Constructor and Destructor


o CATColorPathElement
public CATColorPathElement( const iObject= NULL )
Constructs the class from an object.
Parameters:
iObject
the object which will be the first object of the path. Notice that one
is done on this object.
o CATColorPathElement
public CATColorPathElement( const iPath)
Copy Constructor.
Role: This method creates a new CATColorPathElement which is a copy of the input CATColorPathElement. #param iPath path to copy.
o CATColorPathElement
public CATColorPathElement( const iPathElement,
iSlot= eSlot0)
Constructs the class from a and a slot.
Parameters:
iPathElement
The CATPathElement to copy.
iSlot
The Slot of the color.
o ~CATColorPathElement
public virtual ~CATColorPathElement()
Copy Constructor.

Methods


o Clone
public virtual Clone()
Returns a pointer to a new path of objects which is the clone of the current one.
o GetColorSlot
public GetColorSlot()
Retrieves the color slot.
Returns:
The slot.
o SetColorSlot
public SetColorSlot( iSlot)
set the color slot.
Parameters:
iSlot
The slot.

Enumerated Types


o eSlot 
enum eSlot {
  eSlot0,
  eSlot1,
  eSlot2,
  eSlot3,
  eSlot4,
  eSlot5,
  eSlot6,
  eSlot7,
  eSlot8,
  eSlot9,
  eSlotCount
}
Slot associated with a color.
This object is included in the file: CATColorPathElement.h
If needed, your Imakefile.mk should include the module: CATVisItf

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