GMOperatorsInterfaces CATDynFilletRadius
Usage: you must use this class as is. You should never derive it.
public class CATDynFilletRadius
Class defining the radius properties of an edge in a ribbon.
A CATDynFilletRadius is defined by a cell and a radius value.
The cell is either a vertex, or an edge. In case of an edge, a ratio
on this edge can be given to detail the location of the point on which
the radius value is given. This is especially used for variable radius ribbon.
In case of variable radius ribbon moreover, several CATDynFilletRadius must
be created, referencing the same edge with different radius and locations.
Constructor and Destructor Index
- o
CATDynFilletRadius(double,CATCell*,double*,CATAngle*)
- Constructs a radius definition.
- o
~CATDynFilletRadius()
-
Method Index
- o
GetDirection()
- Returns the angle defining the radius variation at the point on the edge.
- o
GetLocation()
- Returns the cell on which the radius is defined.
- o
GetRadius()
- Returns the radius value associated with the edge of a ribbon.
- o
GetRatio()
- Returns the ratio defining the location of the point on the edge.
- o
HasDirection()
- Tests whether an angle is defined to precise the radius variation at the point on the edge.
- o
HasRatio()
- Tests whether a ratio is defined to precise the location of the point on the edge.
- o
SetDirection(CATAngle)
-
- o
SetLocation(CATCell*)
-
- o
SetRadius(double)
-
- o
SetRatio(double)
-
Constructor and Destructor
o CATDynFilletRadius
| public CATDynFilletRadius( | | iRadius, |
| | iLocation, |
| | iRatio | = NULL, |
| | iDirection | = NULL) |
-
Constructs a radius definition.
- Parameters:
-
- iRadius
- The value of the radius.
- iLocation
- The pointer to the cell (vertex, edge) on which the radius applies.
- iRatio
- The pointer to the ratio of the edge length which defines the point where the radius is defined.
Legal values:
0 <= iRatio <= 1. If NULL, the radius applies on the start vertex of the edge.
- iDirection
- The pointer to the tangent to the radius law at iLocation. If NULL, this is
not taken into account.
Legal values: only use iDirection=NULL as of today.
o ~CATDynFilletRadius
| public virtual ~CATDynFilletRadius( | ) |
-
Methods
o GetDirection
-
Returns the angle defining the radius variation at the point on the edge.
- Returns:
- The angle value, if there is one defined. Use first HasDirection, to test whether this angle is defined.
o GetLocation
-
Returns the cell on which the radius is defined.
- Returns:
- The pointer to the cell.
o GetRadius
-
Returns the radius value associated with the edge of a ribbon.
- Returns:
- The radius value.
o GetRatio
-
Returns the ratio defining the location of the point on the edge.
- Returns:
- The ratio value, if there is one defined. Use first HasRatio, to test whether this value is defined.
o HasDirection
-
Tests whether an angle is defined to precise the radius variation at the point on the edge.
- Returns:
- The result of the test
Legal values: TRUE if it is defined, FALSE otherwise.
o HasRatio
-
Tests whether a ratio is defined to precise the location of the point on the edge.
- Returns:
- The result of the test
Legal values: TRUE if it is defined, FALSE otherwise.
o SetDirection
| public SetDirection( | const | iDirection) |
-
- Parameters:
-
- iDirection
- set direction.
o SetLocation
| public SetLocation( | | iCell) |
-
- Parameters:
-
- iCell
- set the Location Cell.
o SetRadius
| public SetRadius( | const | iRadii) |
-
- Parameters:
-
- iRadii
- Set the radius value.
o SetRatio
| public SetRatio( | const | iRatio) |
-
- Parameters:
-
- iRatio
- set the ratio.
This object is included in the file: CATDynFilletRadius.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.