GMOperatorsInterfaces CATICGMTopHelixOperator
Usage: you must use this class as is. You should never derive it.
public class CATICGMTopHelixOperator
Class defining a topological operator that builds an helix Body.
An helix is defined by:
- iHelixAxis
- The body containing a wire with a single linear
edge.
- iHelixAxisOrientation
- The orientation of the helix
with regards to the axis: iHelixAxisOrientation=1 if the helix and
iHelixAxis have the same orientation, -1 otherwise.
- iHelixOrigin
- The body containing a vertex which point
is the origin point of the helix.
- iStartAngle
- The first limitation of the helix from the
origin point. This angle is considered on the helix itself, rotating about iHelixAxis
according to iTrigoOrientation parameter.
- iEndAngle
- The last limitation of the helix from the
origin point. This angle is considered on the helix itself, rotating about iHelixAxis
according to iTrigoOrientation parameter.
- iPitch
- The heigth between two turns.
- iTrigoOrientation
- The orientation of the rotation about
the axis oriented by iHelixAxisOrientation: 1 to turn counterclockwise,
<-1> to turn clockwise.
- iTaperAngle
- Defines the half angle of the cone on which the helix
is laying: if 0, the helix is computed on a cylinder.
- iTaperAngleOrientation
- Defines the location of the cone apex:
if 1, the cone is widening along the oriented axis, -1, the cone is
sharpening along the oriented axis.
Notice the following definition rules:
- iStartAngle < iEndAngle
- iHelixOrigin is not on the axis.
- 0 <= iTaperAngle < CATPIBY2
An topological helix can be created using two modes:
- Basic mode: use directly the CATCGMCreateTopHelix global function,
that returns the pointer to the created body.
- Advanced mode: use the CATICGMTopHelixOperator as any topological operator:
- Create the operator with the function CATCGMCreateTopHelixOperator,
- Set the parameters to tune the helix properties such as SetTaperAngle,
- Run,
- Get the resulting body,
- Release the operator with the Release method after use.
The created body can be removed from the factory with the method as any CATICGMObject.
Constructor and Destructor Index
- o
CATICGMTopHelixOperator()
- Constructor
Method Index
- o
SetProfile(CATBody*,CATBody*)
- Defines the radius profile of the helix.
- o
SetTaperAngle(CATAngle)
- Defines the half angle of the cone on which the helix is laying.
- o
SetTaperAngleOrientation(CATLONG32)
- Defines the location of the cone apex.
Constructor and Destructor
o CATICGMTopHelixOperator
| public CATICGMTopHelixOperator( | ) |
-
Constructor
Methods
o SetProfile
| public virtual SetProfile( | | iProfileBody, |
| | iPlaneBody) |
-
Defines the radius profile of the helix.
- Parameters:
-
- iProfile
- The pointer to the wire body containing a single planar wire.
This wire describes the radius variation of the helix along the helix axis.
The wire may be composed of several edges.
For each edge of the wire, a helix piece is be built.
The result body returned by GetResult() contains a single wire where all
the helix pieces are connected.
The helix axis and the profile must be logically coplanar. They must have been projected
or laid down on the same plane.
- iPlaneBody
- The pointer to a single shell body, which face is lying on a planar surface.
- Returns:
- Not null in case of error.
o SetTaperAngle
| public virtual SetTaperAngle( | | iTaperAngle) |
-
Defines the half angle of the cone on which the helix is laying.
- Parameters:
-
- iTaperAngle
- if 0 the helix is computed on a cylinder.
- Returns:
- Not null in case of error.
o SetTaperAngleOrientation
| public virtual SetTaperAngleOrientation( | | iTaperAngleOrientation) |
-
Defines the location of the cone apex.
- Parameters:
-
- iTaperAngleOrientation
- if 1, the cone is widening along the oriented axis,
-1, the cone is sharpening along the oriented axis.
- Returns:
- Not null in case of error.
This object is included in the file: CATICGMTopHelixOperator.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.