GeometricObjects Interface CATICldCell

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATICldCell

Interface for the entity CATICldCell.

See also:


Method Index


o AddPoint(float[3])
Adds a point given by its coordinates.
o AddPoint(double[3])
Adds a point given by its coordinates.
o GetCoords(int,float[3])
Returns the coordinates of the iNoPoint'th point.
o GetCoords(int,double[3])
Returns the coordinates of the iNoPoint'th point.
o GetNbPoints()
Returns the number of points.
o IsAFilteredPoint(int)
Tests if the iNoPoint'th point is filtered.
o IsASelectedPoint(int)
Tests if the iNoPoint'th point is selected.
o IsAValidPoint(int)
Tests if the iNoPoint'th point is valid ie.
o IsAnActivePoint(int)
Tests if the iNoPoint'th point is active ie is selected and unfiltered.
o RemovePoint(int)
Removes the iNoPoint'th point.
o SetCoords(int,float[3])
Updates the coordinates of the iNoPoint'th point.
o SetCoords(int,double[3])
Updates the coordinates of the iNoPoint'th point.

Methods


o AddPoint
public virtual AddPoint( const iCoords)
Adds a point given by its coordinates.
Parameters:
iCoords
The coordinates of the point to add.
Returns:
If positive, the index of the added point (the first is equal to 1). If null or negative, the point was not added.
o AddPoint
public virtual AddPoint( const iCoords)
Adds a point given by its coordinates.
Parameters:
iCoords
The coordinates of the point to add.
Returns:
If positive, the index of the added point (the first is equal to 1). If null or negative, the point was not added.
o GetCoords
public virtual GetCoords( const iNoPoint,
oCoords)
Returns the coordinates of the iNoPoint'th point.
Parameters:
iNoPoint
The index of the point. It should be in the range [1,GetNbPoints()].
oCoords
The desired coordinates.
o GetCoords
public virtual GetCoords( const iNoPoint,
oCoords)
Returns the coordinates of the iNoPoint'th point.
Parameters:
iNoPoint
The index of the point. It should be in the range [1,GetNbPoints()].
oCoords
The desired coordinates.
o GetNbPoints
public virtual GetNbPoints()
Returns the number of points.
Returns:
The number of points.
o IsAFilteredPoint
public virtual IsAFilteredPoint( const iNoPoint)
Tests if the iNoPoint'th point is filtered. This tag is managed by an interactive way.
Parameters:
iNoPoint
The index of the point to check. It should be in the range [1,GetNbPoints()].
Returns:
TRUE if the point is filtered, FALSE otherwise.
o IsASelectedPoint
public virtual IsASelectedPoint( const iNoPoint)
Tests if the iNoPoint'th point is selected. This tag is managed by an interactive way.
Parameters:
iNoPoint
The index of the point to check. It should be in the range [1,GetNbPoints()].
Returns:
TRUE if the point is selected, FALSE otherwise.
o IsAValidPoint
public virtual IsAValidPoint( const iNoPoint)
Tests if the iNoPoint'th point is valid ie. not removed.
Parameters:
iNoPoint
The index of the point to check. It should be in the range [1,GetNbPoints()].
Returns:
TRUE if the point is valid, FALSE otherwise.
o IsAnActivePoint
public virtual IsAnActivePoint( const iNoPoint)
Tests if the iNoPoint'th point is active ie is selected and unfiltered. This tag is managed by an interactive way.
Parameters:
iNoPoint
The index of the point to check. It should be in the range [1,GetNbPoints()].
Returns:
TRUE if the point is active, FALSE otherwise.
o RemovePoint
public virtual RemovePoint( const iNoPoint)
Removes the iNoPoint'th point.
Parameters:
iNoPoint
The index of the point to remove. It should be in the range [1,GetNbPoints()].
o SetCoords
public virtual SetCoords( const iNoPoint,
iCoords)
Updates the coordinates of the iNoPoint'th point.
Parameters:
iNoPoint
The index of the point. It should be in the range [1,GetNbPoints()].
iCoords
The new coordinates.
o SetCoords
public virtual SetCoords( const iNoPoint,
iCoords)
Updates the coordinates of the iNoPoint'th point.
Parameters:
iNoPoint
The index of the point. It should be in the range [1,GetNbPoints()].
iCoords
The new coordinates.

This object is included in the file: CATICldCell.h
If needed, your Imakefile.mk should include the module: CATGMGeometricInterfaces

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