All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMOperatorsInterfaces Interface CATICGMDynTransformation

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATICGMDynTransformation

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.

A CATICGMDynTransformation is created with the CATCGMCreateDynTransformation global function: It must be directly released with the Release method. It is not streamable.
Options can be precised with the SetXxx methods, before asking for the computation with the Run method. In particular, the operator can be re-use to transform the same body with different transformations; in this case, you can precise another journal to be filled, with the SetNewJournal method.
The result is accessed with the GetResult method.

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

Method Index

o SetAffinity(CATMathPlane&,CATLength): Defines this CATICGMDynTransformation 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(CATCGMDynTransformationReportMode): Defines the type of follow-up of the modifications to write in the journal.
o SetRotation(CATAngle,CATMathLine&): Defines this CATICGMDynTransformation as a rotation.
o SetScaling(CATMathPoint&,CATLength): Defines this CATICGMDynTransformation as a scaling.
o SetSymmetry(CATMathPlane&): Defines this CATICGMDynTransformation as a symmetry.
o SetTransformation(CATMathTransformation&): Sets to this CATICGMDynTransformation the parameters of a given transformation.
o SetTranslation(CATMathVector&): Defines this CATICGMDynTransformation as a translation.

Methods

o SetAffinity

public virtual SetAffinity(	const	`iReflectPlane`,
		`iRatio`)

Defines this CATICGMDynTransformation 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 SetJournalInfo( iTrueOrFalse)

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 SetNewJournal( iJournal)

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 SetReportMode( iTypeOfFollowUp)

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:

CATCGMDynTransformationModification: 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 CATICGMDynTransformation.
CATCGMDynTransformationCreation: 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 SetRotation(	const	`iAngle`,
	const	`iAxis`)

Defines this CATICGMDynTransformation as a rotation.

Parameters:

iAngle: The angle of the rotation (in radians).
iAxis: The direction of the rotation.

o SetScaling

public virtual SetScaling(	const	`iOrigin`,
		`iRatio`)

Defines this CATICGMDynTransformation as a scaling.

Parameters:

iOrigin: The origin of the scaling.
iRatio: The value of the scaling

o SetSymmetry

public virtual SetSymmetry( const iSymmetryPlane)

Defines this CATICGMDynTransformation as a symmetry.

Parameters:

iSymmetryPlane: The plane of symmetry.

o SetTransformation

public virtual SetTransformation( const iTransformation)

Sets to this CATICGMDynTransformation the parameters of a given transformation.

Parameters:

iTransformation: The mathematical definition of the transformation.

o SetTranslation

public virtual SetTranslation( const iTranslationVector)

Defines this CATICGMDynTransformation as a translation.

Parameters:

iTranslationVector: The vector of the translation.

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