VisualizationFoundation CATPickPath
Usage: you must use this class as is. You should never derive it.
public class CATPickPath
Class representing a single graphical representation within a visualized viewer.
Role : it describes a graphical path within a graphical tree. It also
holds information concerning the viewer. These objects are generated by the picking
algorithm.
Constructor and Destructor Index
- o
CATPickPath(CATRep*)
- Constructor.
- o
CATPickPath(CATViewpoint*)
- Default constructor.
- o
CATPickPath(CATPickPath&)
- Copy constructor.
- o
~CATPickPath()
-
Method Index
- o
Get2DMatrix()
- Associates a 2 dimensions matrix to this pickPath.
- o
GetGlobalIntersection()
- Gets the global point of intersection.
- o
GetGlobalNormal()
- Gets the global normal at the intersection point.
- o
GetIntersection()
- Gets the point of intersection.
- o
GetMatrix()
- Gets the associated 3D matrix.
- o
GetNormal()
- Gets the normal at the point of intersection.
- o
GetTangent()
- Gets the tangent at the point of intersection.
- o
GetTopRep()
- Gets the first graphic representation of the pickPath.
- o
HasSubElement()
- Indicates if the repPath has sub-elements.
- o
Load(int)
- Loads a new sub-element in the pickPath.
- o
Load(CATRep*)
- Loads a new graphic representation.
- o
Load(list<int>&)
- Loads a new sub-element list in the pickPath.
- o
SetIntersection(CATMathPointf&)
- Sets the point of intersection.
- o
SetMatrix(CAT3x3Matrix&)
- Associates a 3 dimensions matrix to this pickPath.
- o
SetMatrix(CAT4x4Matrix&)
- Associates a 3 dimensions matrix to this pickPath.
- o
SetNormal(CATMathDirectionf&)
- Sets normal at the point of intersection.
- o
SetTangent(CATMathDirectionf&)
- Sets tangent at the point of intersection.
- o
operator =(CATPickPath&)
- Operator of assignment.
Constructor and Destructor
o CATPickPath
| public CATPickPath( | | iRep) |
-
Constructor.
Role : create a pickPath and add the first
graphic representation in it.
- Parameters:
-
- iRep
- The first graphic regresentation to add.
o CATPickPath
| public CATPickPath( | | viewpoint | = NULL) |
-
Default constructor.
- Parameters:
-
- iViewpointWherePathIsDrawn
- The viewpoint in wich the graphic representation will be drawn.
o CATPickPath
| public CATPickPath( | const | iPickPath) |
-
Copy constructor.
- Parameters:
-
- iPickPath
- The pickPath to copy.
o ~CATPickPath
| public virtual ~CATPickPath( | ) |
-
Methods
o Get2DMatrix
-
Associates a 2 dimensions matrix to this pickPath.
- Parameters:
-
- iMatrix
- The 3 by 3 matrix.
o GetGlobalIntersection
| public GetGlobalIntersection( | ) |
-
Gets the global point of intersection.
Role : Gets the point of intersection taking
account the matrix associated to the path.
- Returns:
- The global point of intersection.
o GetGlobalNormal
-
Gets the global normal at the intersection point.
Role : Gets the normal vector at
the point of intersection, taking
account the matrix associated to the path.
- Returns:
- The global normal.
o GetIntersection
-
Gets the point of intersection.
Role : Gets the point of intersection.
- Returns:
- The point of intersection.
o GetMatrix
-
Gets the associated 3D matrix.
- Returns:
- The associated 4 by 4 matrix.
o GetNormal
-
Gets the normal at the point of intersection.
Role : Get's the normal at
the point of intersection.
- Returns:
- The normal vector.
o GetTangent
-
Gets the tangent at the point of intersection.
Role : Get's the tangent at
the point of intersection.
- Returns:
- The tangent vector.
o GetTopRep
-
Gets the first graphic representation of the pickPath.
- Returns:
- The first graphic representation of the pickPath.
o HasSubElement
-
Indicates if the repPath has sub-elements.
- Returns:
- The number of sub-elements, returns 0 if no sub-element.
o Load
| public Load( | const | iSubElement) |
-
Loads a new sub-element in the pickPath.
Role : Add a sub-element defined by an index
in the sub-element list of the pickPath.
- Parameters:
-
- iSubElement
- The index of the sub-element to add.
o Load
-
Loads a new graphic representation.
Role : add a graphic representation at the end
of the pickPath.
- Parameters:
-
- iRep
- The grahic representation to add.
o Load
| public Load( | const | ipSubElementIdList) |
-
Loads a new sub-element list in the pickPath.
Role : Replace the sub-element list of the pickPath
by the one given as input parameter.
- Parameters:
-
- ipSubElementIdList
- The list of sub-element to use to replace the pickpath current list.
o SetIntersection
| public SetIntersection( | const | iIntersection) |
-
Sets the point of intersection.
Role : Sets the point of intersection.
- Parameters:
-
- iIntersection
- The point of intersection to value.
o SetMatrix
| public SetMatrix( | const | ) |
-
Associates a 3 dimensions matrix to this pickPath.
Role :
- Parameters:
-
- iMatrix
- The 3 by 3 matrix.
o SetMatrix
| public SetMatrix( | const | iMatrix) |
-
Associates a 3 dimensions matrix to this pickPath.
Role :
- Parameters:
-
- iMatrix
- The 4 by 4 matrix.
o SetNormal
| public SetNormal( | const | iNormal) |
-
Sets normal at the point of intersection.
Role : Sets the normal at the
point of intersection.
- Parameters:
-
- iNormal
- The normal to value.
o SetTangent
| public SetTangent( | const | iTangent) |
-
Sets tangent at the point of intersection.
Role : Sets the tangent at the
point of intersection.
- Parameters:
-
- iTangent
- The tangent to value.
o operator =
| public operator =( | const | iPickPath) |
-
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: CATPickPath.h
If needed, your Imakefile.mk should include the module: CATVisFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.