VisualizationFoundation CATPickPathList

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

public class CATPickPathList

Class representing a list of CATPickPath .
Role :
This list is created empty, then elements are added or removed through
the use of operators += or -=.
To be properly used, the list may be sorted and the result is to follow
the following rules:

  1. Element type order: Overlay, non Z buffer, Z buffer.
  2. Visual mode order:
    - Default: Sort by deep from the eye position, then by dimension,
    - Wireframe (EDGE and no MESH): Sort by dimension, then by deep.

The sorting configuration is to be specified to the sort method.

Lifecycle rules deviation:
PickPaths stored inside the CATPickPath list are neither copied nor des-
troyed at the object destruction. A call to the Reset method makes the
destruction of stored paths efficient.

Constructor and Destructor Index


o CATPickPathList()
Default constructor.
o ~CATPickPathList()

Method Index


o GetPathCount()
Returns the size of the list.
o GetPickPathList()
Returns a copy of the internal list.
o IsContained(CATPickPath*)
Checks if a pickPath is in the list.
o Reset()
Destroyes the list.
o SortGraphicAttributeSet(CATPickPriority)
Sorts the list.
o operator +=(CATPickPath&)
Operator of assignment.
o operator -=(CATPickPath&)
Operator of subtraction.
o operator =(CATPickPathList&)
Operator of assignment.
o operator =(CATPickPathList&)
Operator of assignment.

Constructor and Destructor


o CATPickPathList
public CATPickPathList()
Default constructor.
Create an empty list of pickpaths.
o ~CATPickPathList
public virtual ~CATPickPathList()

Methods


o GetPathCount
public GetPathCount()
Returns the size of the list.
Role : Gives the number of
elements in the list.
Returns:
The size.
o GetPickPathList
public GetPickPathList()
Returns a copy of the internal list.
Returns:
A copy of the internal list.
o IsContained
public IsContained( iPickPath)
Checks if a pickPath is in the list.
Role : Look for the
in parameter in the internal list.
Parameters:
iPickPath
The pickpath to look for.
Returns:
The result of the search.
Legal values:
  1. 0 if the parameter is not found
  2. A positif value is the pickpath is found
o Reset
public Reset()
Destroyes the list.
Role : Deletes all pickpaths in the list
and empty the list.

Lifecycle rules deviation: This class doesn't
manage the lifecycle of added and removed elements in it.
This method is the single that actually deletes elements
from memory.
o SortGraphicAttributeSet
public SortGraphicAttributeSet( iOrder= PICK_DEFAULT)
Sorts the list.
Role : Sorts elements in the list.
Order is generated by element type first:
  1. Overlay
  2. NonZBuffer
  3. ZBuffer

Then sort is made relying on the order given in parameter :
  1. PICK_DEFAULT : Deep is used first, then dimension.
  2. PICK_WIREFRAME : Dimension is used first, then deep.

Parameters:
iOrder
The type of order to apply.
o operator +=
public operator +=( iPickPath)
Operator of assignment.
Role : Add a new in the list.
Parameters:
iPickPath
The new pickpath to add.
o operator -=
public operator -=( iPickPath)
Operator of subtraction.
Role : Remove a previously added
from the list.
Parameters:
iPickPath
The pickpath to remove.
o operator =
public operator =( iPickPathList)
Operator of assignment.
Parameters:
iPickPath
The pickPath use to create a new one identical.
Returns:
The new pickPath created by assignment.
o operator =
public operator =( const iPickPathList)
Operator of assignment.
Parameters:
iPickPath
The pickPath use to create a new one identical.
Returns:
The new pickPath created by assignment.
This object is included in the file: CATPickPathList.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

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