GMOperatorsInterfaces CATICGMTopPrism
Usage: you must use this class as is. You should never derive it.
public class CATICGMTopPrism
Class representing the topological operator that creates a prism.
The operator extrudes
- either a wire body, and creates a skin body
- or a skin body, ans creates a volume body.
In addition to the prism creation, this operator provides the capability
to use a Boolean operation between a body (called trimming body), and the
created prism. A typical example is the stiffener. The stiffener itself is created by extruding a
profile, the resulting body is obtained by specifying a boolaan operation to stick the stiffener to
a support body. To obtain such result, use the and
mehods of the parent class.
The CATICGMTopPrism operator follows the global frame of the topological operators
and satisfies the smart mechanism: the
input body is not modified. A new resulting body is created,
possibly sharing data with the input body. A CATICGMTopPrism operator is not streamable.
To use it:
- Create it with the CATCGMCreateTopPrism global function.
- Tune it with appropriate options, using the SetXxx methods. In particular,
define the type of limitations, and, if needed, the Boolean operation.
- Run it
- Get the resulting extrusion with the
method, and the result of the Boolean operation with the
method. If you do not want to keep these resulting bodies, use the
method to remove them from the geometric factory, after the operator deletion.
- Release the operator with the Release method after use.
Constructor and Destructor Index
- o
CATICGMTopPrism()
- Constructor
Method Index
- o
GetLength(CATMathPoint&,CATMathDirection&,double&,double&)
- Retrieves the main features of the created prism.
- o
SetExtrudeLimit(CATTopLimit,CATTopLimitType,CATBoolean,CATLength,CATGeometry*,CATBody*,CATTopPropagationType,CATLength)
- Defines the type of limitation of each extremity along the extrusion (center curve) direction.
- o
SetExtrudeLimit(CATTopLimit,CATTopLimitType,CATBoolean,CATLength,CATLISTP(CATCell)&,CATBody*,CATTopPropagationType,CATLength)
- Defines the type of limitation of each extremity along the extrusion (center curve) direction.
- o
SetLimit(CATTopLimit,CATTopLimitType,CATBoolean,CATLength,CATGeometry*,CATBody*,CATTopPropagationType,CATBoolean)
-
- o
SetLimit(CATTopLimit,CATTopLimitType,CATBoolean,CATLength,CATLISTP(CATCell)&,CATBody*,CATTopPropagationType,CATBoolean)
-
Constructor and Destructor
o CATICGMTopPrism
-
Constructor
Methods
o GetLength
| public virtual GetLength( | const | iOrigin, |
| const | iDirection, |
| | oLengthMin, |
| | oLengthMax) |
-
Retrieves the main features of the created prism.
To use after the Run method, to retrieve an upper bound of the prism length.
- Parameters:
-
- iOrigin
- The reference from which the distances are computed.
- iDirection
- The direction in which the distances are computed.
- oLengthMin
- The distance from iOrigin of the first limit.
- oLengthMax
- The distance from iOrigin of the end limit.
o SetExtrudeLimit
| public virtual SetExtrudeLimit( | | iId, |
| | iType, |
| | iIsAxisReverted, |
| | iOffset, |
| | iLimit, |
| | iPropagationBody, |
| | iPropagationFlag, |
| | iThickness | = CATLength(0)) |
-
Defines the type of limitation of each extremity along the extrusion (center curve) direction.
To be called for each extremity, if you do not want to keep
the default options of the global creation function.
- Parameters:
-
- iId
- The first or last extremity.
- iType
- The type of limit on the extremity.
- iIsAxisReverted
- The orientation.
Legal values: TRUE for the same orientation as the direction defined at the operator
creation, FALSE for an opposite orientation. In general, use TRUE for the start limit,
and FALSE for the end limit.
- iOffset
- The value of the offset if iType has the value CatLimOffsetFromProfile.
- iLimit
- The pointer to the geometry or the topology that stops the extrusion.
- iPropagationBody
- The pointer to the body which contains iLimit, thus allowing the
propagation of the trimming specification. To use if iType = CatLimUntil and
iPropagationFlag = CatPropagClosing or if iType = CatLimNextAlongAxis
or iType = CatLimLastAlongAxis
- iPropagationFlag
- The management of the propagation.
- iThickness
- defines the value of any thickness which must be applied to the considering relimitation
o SetExtrudeLimit
| public virtual SetExtrudeLimit( | | iId, |
| | iType, |
| | iIsAxisReverted, |
| | iOffset, |
| | iLimit, |
| | iPropagationBody, |
| | iPropagationFlag, |
| | iThickness | = CATLength(0)) |
-
Defines the type of limitation of each extremity along the extrusion (center curve) direction.
To be called for each extremity, if you do not want to keep
the default options of the global creation function.
- Parameters:
-
- iId
- The first or last extremity.
- iType
- The type of limit on the extremity.
- iIsAxisReverted
- The orientation.
Legal values: TRUE for the same orientation as the direction defined at the operator
creation, FALSE for an opposite orientation. In general, use TRUE for the start limit,
and FALSE for the end limit.
- iOffset
- The value of the offset if iType has the value CatLimOffsetFromProfile.
- iLimit
- The pointer to the geometry or the topology that stops the extrusion.
- iPropagationBody
- The pointer to the body which contains iLimit, thus allowing the
propagation of the trimming specification. To use if iType = CatLimUntil and
iPropagationFlag = CatPropagClosing or if iType = CatLimNextAlongAxis
or iType = CatLimLastAlongAxis
- iPropagationFlag
- The management of the propagation.
- iThickness
- defines the value of any thickness which must be applied to the considering relimitation
o SetLimit
| public virtual SetLimit( | | iId, |
| | iType, |
| | iIsAxisReverted, |
| | iOffset, |
| | iLimit, |
| | iPropagationBody, |
| | iPropagationFlag, |
| | iIsThickness | = CATBoolean(0)) |
-
- Deprecated:
- V5R21 SetExtrudeLimit
Defines the type of limitation of each extremity along the extrusion direction.
To be called for each extremity, if you do not want to keep
the default options of the global creation function.
- Parameters:
-
- iId
- The first or last extremity.
- iType
- The type of limit on the extremity.
- iIsAxisReverted
- The orientation.
Legal values: FALSE for the same orientation as the direction defined at the operator
creation, TRUE for an opposite orientation. In general, use TRUE for the start limit,
and FALSE for the end limit.
- iOffset
- Either the value of the offset if iType is valued to CatLimOffsetFromProfile,
or the value of the thickness if iIsThickness is valued to CATBoolean(1)
- iLimit
- The pointer to the geometry ( deprecated ) or a body that stops the extrusion.
- iPropagationBody
- The pointer to the body which contains iLimit, thus allowing the
propagation of the trimming specification. To use if iType = CatLimUntil and
iPropagationFlag = CatPropagClosing or if iType = CatLimNextAlongAxis
or iType = CatLimLastAlongAxis
- iPropagationFlag
- The management of the propagation.
If iType = CatLimUntil and iPropagationFlag = CatPropagExtrapolated ,
extrapolation works only if iLimit is a single face body.
- iIsThickness
- Defines whether a thickness is applied from the body iPropagationBody to define the relimitation.
In this case, the value of the the thickness is iOffset
o SetLimit
| public virtual SetLimit( | | iId, |
| | iType, |
| | iIsAxisReverted, |
| | iOffset, |
| | iLimit, |
| | iPropagationBody, |
| | iPropagationFlag, |
| | iIsThickness | = CATBoolean(0)) |
-
- Deprecated:
- V5R21 SetExtrudeLimit
Defines the type of limitation of each extremity along the extrusion direction.
To be called for each extremity , if you do not want to keep
the default options of the global creation function.
- Parameters:
-
- iId
- The first or last extremity.
- iType
- The type of limit on the extremity.
- iIsAxisReverted
- The orientation.
Legal values: TRUE for the same orientation as the direction defined at the operator
creation, FALSE for an opposite orientation. In general, use TRUE for the start limit,
and FALSE for the end limit.
- iOffset
- Either the value of the offset if iType is valued to CatLimOffsetFromProfile,
or the value of the thickness if iIsThickness is valued to CATBoolean(1)
- iLimit
- The list of pointers to faces belonging to iPropagationBody that stop the extrusion.
- iPropagationBody
- The pointer to the body which contains iLimit, thus allowing the
propagation of the trimming specification. To use if iType = CatLimUntil and
iPropagationFlag = CatPropagClosing or if iType = CatLimNextAlongAxis
or iType = CatLimLastAlongAxis
- iPropagationFlag
- The management of the propagation.
- iIsThickness
- Defines whether a thickness is applied from the body iPropagationBody to define the relimitation.
In this case, the value of the the thickness is iOffset
This object is included in the file: CATICGMTopPrism.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.