All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

TopologicalOperators Class CATTopPrism

Mathematics.CATCGMVirtual
  |
  +---GeometricObjects.CATCGMOperator
    |
    +---NewTopologicalObjects.CATTopOperator
      |
      +---TopologicalOperators.CATTopExtrude
        |
        +---CATTopPrism
 

Usage: you must use this class as is. You should never derive it.


public class CATTopPrism

Class representing the topological operator that creates a prism.

The operator extrudes


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. To obtain such result, use the CATTopExtrude.SetOperation and CATTopExtrude.SetTrim mehods of the parent class.
The CATTopPrism 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 CATTopPrism operator is not streamable. To use it:


Constructor and Destructor Index


o ~CATTopPrism()
Destructor.

Method Index


o GetLength(CATMathPoint&,CATMathDirection&,double&,double&)
Retrieves the main features of the created prism.
o SetLimit(CATTopLimit,CATTopLimitType,CATBoolean,CATLength,CATGeometry*,CATBody*,CATTopPropagationType,CATBoolean)
Defines the type of limitation of each extremity along the extrusion direction.
o SetLimit(CATTopLimit,CATTopLimitType,CATBoolean,CATLength,ListPOfCATCell&,CATBody*,CATTopPropagationType,CATBoolean)
Defines the type of limitation of each extremity along the extrusion direction.

Constructor and Destructor


o ~CATTopPrism
public virtual ~CATTopPrism()
Destructor.

Methods


o GetLength
public virtual void GetLength( const CATMathPoint& iOrigin,
const CATMathDirection& iDirection,
double& oLengthMin,
double& oLengthMax) = 0
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 SetLimit
public virtual void SetLimit(CATTopLimit iId,
CATTopLimitType iType,
CATBoolean iIsAxisReverted,
CATLength iOffset,
CATGeometry* iLimit,
CATBody* iPropagationBody,
CATTopPropagationType iPropagationFlag,
CATBoolean iIsThickness= CATBoolean(0)) = 0
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 void SetLimit(CATTopLimit iId,
CATTopLimitType iType,
CATBoolean iIsAxisReverted,
CATLength iOffset,
ListPOfCATCell& iLimit,
CATBody* iPropagationBody,
CATTopPropagationType iPropagationFlag,
CATBoolean iIsThickness= CATBoolean(0)) = 0
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: CATTopPrism.h
If needed, your Imakefile.mk should include the module: CATTopologicalOperators

Copyright © 2003, Dassault Systèmes. All rights reserved.