All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

TopologicalOperators Class CATDynTransformation

Mathematics.CATCGMVirtual
  |
  +---GeometricObjects.CATCGMOperator
    |
    +---NewTopologicalObjects.CATTopOperator
      |
      +---TopologicalOperators.CATDynOperator
        |
        +---CATDynTransformation
 

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


public class CATDynTransformation

Class representing the topological operator that transforms a CATBody.

It follows the use frame of all operator and satisfies to the smart mechanism: the input body is not modified. A new resulting body is created, possibly sharing data with the input one.

This operator is optimized and simplified with regards to the CATTransfoManager : The CATDynTransfomation operator chooses the best way to call the CATTransfoManager. In another way, the CATTransfoManager provides more options.


Constructor and Destructor Index


o ~CATDynTransformation()
Destructor.

Method Index


o SetAffinity(CATMathPlane&,CATLength)
Defines this CATDynTransformation as an affinity.
o SetJournalInfo(CATBoolean)
Defines whether a CATCGMJournalInfo has to be added to the item corresponding to this operation.
o SetNewJournal(CATCGMJournalList*)
Defines another journal to be filled after another run of this operator.
o SetReportMode(CATDynReportMode)
Defines the type of follow-up of the modifications to write in the journal.
o SetRotation(CATAngle,CATMathLine&)
Defines this CATDynTransformation as a rotation.
o SetScaling(CATMathPoint&,CATLength)
Defines this CATDynTransformation as a scaling.
o SetSymmetry(CATMathPlane&)
Defines this CATDynTransformation as a symmetry.
o SetTransformation(CATMathTransformation&)
Sets to this CATDynTransformation the parameters of a given transformation.
o SetTranslation(CATMathVector&)
Defines this CATDynTransformation as a translation.

Enumerated Type Index


o CATDynReportMode
Type of follow-up to be written in the journal.

Constructor and Destructor


o ~CATDynTransformation
public virtual ~CATDynTransformation()
Destructor.

Methods


o SetAffinity
public virtual void SetAffinity( const CATMathPlane& iReflectPlane,
CATLength iRatio) = 0
Defines this CATDynTransformation as an affinity.
Parameters:
iReflectPlane
The plane for the reflecting part of the affinity.
iRatio
The value of the ratio for the scaling part of the affinity.
The value iRatio=-1 is the only value allowed for the moment. Use better the SetSymmetry method.
o SetJournalInfo
public virtual void SetJournalInfo(CATBoolean iTrueOrFalse) = 0
Defines whether a CATCGMJournalInfo has to be added to the item corresponding to this operation.
Parameters:
iTrueOrFalse
TRUE if an additional information must be added to the item, FALSE otherwise. In case of adding the additional information, this information is put to 0.
o SetNewJournal
public virtual void SetNewJournal(CATCGMJournalList* iJournal) = 0
Defines another journal to be filled after another run of this operator.
Parameters:
iJournal
The pointer to the new journal to be filled in another run. This can be used in case of pattern transformation, if you want that each occurence has a different journal.
o SetReportMode
public virtual void SetReportMode(CATDynReportMode iTypeOfFollowUp) = 0
Defines the type of follow-up of the modifications to write in the journal.
This information is used by applications, depending on the type of operations they want to perform after calling the transformation. This information has no impact on the objects of the geometric modeler itself.
Parameters:
iTypeOfFollowUp
The type of report mode.
Legal values:
CATDynModification
The transformation is seen as a modification: the body is always duplicated, but the application wants to mask the input body for showing only the resulting body (case of an applicative transformation). This is the default of a CATDynTransformation.
CATDynCreation
The transformation is seen as a creation: The application keeps the input body and the duplicated body, and wants to union them for example: this is a typical case of an applicative operation of mirror.
o SetRotation
public virtual void SetRotation( const CATAngle iAngle,
const CATMathLine& iAxis) = 0
Defines this CATDynTransformation as a rotation.
Parameters:
iAngle
The angle of the rotation (in radians).
iAxis
The direction of the rotation.
o SetScaling
public virtual void SetScaling( const CATMathPoint& iOrigin,
CATLength iRatio) = 0
Defines this CATDynTransformation as a scaling.
Parameters:
iOrigin
The origin of the scaling.
iRatio
The value of the scaling
o SetSymmetry
public virtual void SetSymmetry( const CATMathPlane& iSymmetryPlane) = 0
Defines this CATDynTransformation as a symmetry.
Parameters:
iSymmetryPlane
The plane of symmetry.
o SetTransformation
public virtual void SetTransformation( const CATMathTransformation& iTransformation) = 0
Sets to this CATDynTransformation the parameters of a given transformation.
Parameters:
iTransformation
The mathematical definition of the transformation.
o SetTranslation
public virtual void SetTranslation( const CATMathVector& iTranslationVector) = 0
Defines this CATDynTransformation as a translation.
Parameters:
iTranslationVector
The vector of the translation.

Enumerated Types


o CATDynReportMode
enum CATDynReportMode {
  CATDynModification,
  CATDynCreation
}
Type of follow-up to be written in the journal.
This information is used by applications, depending on the type of operations they want to perform after calling the transformation. This information has no impact on the objects of the geometrical modeler itself.
Parameters:
CATDynModification
The transformation is seen as a modification: the body is always duplicated, but the application wants to mask the input body for showing only the resulting body (case of an applicative transformation). This is the default of a CATDynTransformation.
CATDynCreation
The transformation is seen as a creation: The application keeps the input body and the duplicated body, and wants to union them for example: this is a typical case of an applicative operation of mirror.

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

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