VisualizationFoundation CAT3DMarkerGPEditHelper
Usage: you must use this class as is. You should never derive it.
public class CAT3DMarkerGPEditHelper
Class to edit CAT3DMarkerGP graphic primitive
CATGraphicPrimitive are immutable objects.
To be able to modify these object's data without having to copy the whole primitive,
this class empty the original graphic primitve, exposes methods to modify these data, then creates a new primitive with these data.
The old primitive can then be replaced with the new primitive.
Constructor and Destructor Index
- o
CAT3DMarkerGPEditHelper()
- Constructor.
- o
~CAT3DMarkerGPEditHelper()
- Destructor.
Method Index
- o
Get(float**,int*,CATSymbolType*)
- Retrieves marked points coordinates and the symbol type used
to mark them.
- o
GetMarker()
- Return the currently edited CAT3DMarkerGP
- o
IsEditionPossible(CAT3DMarkerGP*,CATRep*)
- Get if the edition of the given graphic primitive is possible, and if not, why.
- o
Reset(CAT3DMarkerGP*,CATRep*)
- Set the currenlty edited CAT3DMarkerGP with its edition context.
- o
ResetExtended(CAT3DMarkerGP*,CATRep*,unsigned int)
- Set the currenlty edited CAT3DMarkerGP with its edition context.
- o
SetSymbolType(CATSymbolType)
- sets the symbol used to mark the points to a new value.
Data Member Index
- o
ReplaceByDuplicateIfMultiAggreg
-
Constructor and Destructor
o CAT3DMarkerGPEditHelper
| public CAT3DMarkerGPEditHelper( | ) |
-
Constructor.
o ~CAT3DMarkerGPEditHelper
| public ~CAT3DMarkerGPEditHelper( | ) |
-
Destructor.
If the EditHelper is not empty, the edition context is notified.
Methods
o Get
| public Get( | | oPoints, |
| | oNbPoint, |
| | oSymbol) |
-
Retrieves marked points coordinates and the symbol type used
to mark them.
This method must be called this way:
float const* points;
int nbPoints;
SymbolType symbol;
Get(&points, &NbPoints, &symbol);
- Parameters:
-
- oPoints
- Retrieves an array containing marked points coordinates: XYZXYZXYZ...
Its size is equal to three times the number of marked points.
- oNbPoints
- Retrieves the number of points marked by this 3D marker.
- oSymbol
- Retrieves the symbol used to mark the points.
o GetMarker
-
Return the currently edited CAT3DMarkerGP
- Returns:
- The currently edited CAT3DMarkerGP
If the EditHelper was empty, NULL is returned.
o IsEditionPossible
| public static IsEditionPossible( | | iMarker, |
| | iRep) |
-
Get if the edition of the given graphic primitive is possible, and if not, why.
- Parameters:
-
- iMarker
- The marker to be edited
- iRep
- The Rep which should contain the marker
- Returns:
- A CATGraphicPrimitiveEditHelper::EditAuthorization value, depending of the context.
o Reset
| public Reset( | | iMarker, |
| | iRep) |
-
Set the currenlty edited CAT3DMarkerGP with its edition context. Compared to Reset, this methods supports additional flags
which can perform operation to ensure that some edition features will be supported.
In case of success, if the EditHelper is not empty, the old edition context is notified.
- Parameters:
-
- iMarker
- The CAT3DMarkerGP instance which will be edited.
- iRep
- The Rep containing the CAT3DMarkerGP. Currently supported rep are CATSurfacicRep and CAT3DCustomRep.
If the marker is not contained in any Rep, this parameter can be NULL
- Returns:
- If the marker can be edited in the provided context, S_OK, otherwise, E_FAIL
It should be noted that if the marker is contained in more than one Rep, it will always fail.
If the marker is contained in a Stripped SurfacicRep, it will fail.
o ResetExtended
| public ResetExtended( | | iMarker, |
| | iRep, |
| | iFlags) |
-
Set the currenlty edited CAT3DMarkerGP with its edition context. Compared to Reset, this methods supports additional flags
which can perform operation to ensure that some edition features will be supported.
In case of success, if the EditHelper is not empty, the old edition context is notified.
- Parameters:
-
- iMarker
- The CAT3DMarkerGP instance which will be edited.
- iRep
- The Rep containing the CAT3DMarkerGP. Currently supported rep are CATSurfacicRep and CAT3DCustomRep.
If the marker is not contained in any Rep, this parameter can be NULL
- iFlags
- Additional flags which will perform operation needed to access some edition features.
-ReplaceByDuplicateIfMultiAggreg : If the marker is aggregated in more than one Rep, this flag will make a copy of the marker and replace the
original marker in the rep.
- Returns:
- If the marker can be edited in the provided context, S_OK, otherwise, E_FAIL
It should be noted that if the marker is contained in more than one Rep, it will always fail.
If the marker is contained in a Stripped SurfacicRep, it will fail.
o SetSymbolType
| public SetSymbolType( | | iSymbol) |
-
sets the symbol used to mark the points to a new value.
- Parameters:
-
- iSymbol
- The new symbol you wish to use.
Data Members
o ReplaceByDuplicateIfMultiAggreg
public static const unsigned int ReplaceByDuplicateIfMultiAggreg
-
This object is included in the file: CAT3DMarkerGPEditHelper.h
If needed, your Imakefile.mk should include the module: CATVisFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.