Back to index

salome-geom  6.5.0
Public Member Functions
GEOM::GEOM_ITransformOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM::GEOM_ITransformOperations:
Inheritance graph
[legend]
Collaboration diagram for GEOM::GEOM_ITransformOperations:
Collaboration graph
[legend]

List of all members.

Public Member Functions

GEOM_Object TranslateTwoPoints (in GEOM_Object theObject, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
 Translate the given object along the vector, specified by its end points.
GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
 Translate the given object along the vector, specified by its end points, creating its copy before the translation.
GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject, in double theDX, in double theDY, in double theDZ)
 Translate the given object along the vector, specified by its components.
GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject, in double theDX, in double theDY, in double theDZ)
 Translate the given object along the vector, specified by its components, creating its copy before the translation.
GEOM_Object TranslateVector (in GEOM_Object theObject, in GEOM_Object theVector)
 Translate the given object along the given vector.
GEOM_Object TranslateVectorCopy (in GEOM_Object theObject, in GEOM_Object theVector)
 Translate the given object along the given vector, creating its copy before the translation.
GEOM_Object TranslateVectorDistance (in GEOM_Object theObject, in GEOM_Object theVector, in double theDistance, in boolean theCopy)
 Translate the given object along the given vector on given distance, creating its copy before the translation.
GEOM_Object MultiTranslate1D (in GEOM_Object theObject, in GEOM_Object theVector, in double theStep, in long theNbTimes)
 Translate the given object along the given vector a given number times.
GEOM_Object MultiTranslate2D (in GEOM_Object theObject, in GEOM_Object theVector1, in double theStep1, in long theNbTimes1, in GEOM_Object theVector2, in double theStep2, in long theNbTimes2)
 Conseqently apply two specified translations to theObject specified number of times.
GEOM_Object RotateThreePoints (in GEOM_Object theObject, in GEOM_Object theCentPoint, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
 Rotate given object around vector perpendicular to plane containing three points.
GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject, in GEOM_Object theCentPoint, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
 Rotate given object around vector perpendicular to plane containing three points.
GEOM_Object Rotate (in GEOM_Object theObject, in GEOM_Object theAxis, in double theAngle)
 Rotate the given object around the given axis on the given angle.
GEOM_Object RotateCopy (in GEOM_Object theObject, in GEOM_Object theAxis, in double theAngle)
 Rotate the given object around the given axis on the given angle, creating its copy before the rotatation.
GEOM_Object MultiRotate1D (in GEOM_Object theObject, in GEOM_Object theAxis, in long theNbTimes)
 Rotate the given object around the given axis a given number times.
GEOM_Object MultiRotate2D (in GEOM_Object theObject, in GEOM_Object theAxis, in double theAngle, in long theNbTimes1, in double theStep, in long theNbTimes2)
 Rotate the given object around the given axis on the given angle a given number times and multi-translate each rotation result.
GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane)
 Replace the given object by an object, symmetrical to it relatively the given plane.
GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane)
 Create an object, symmetrical to the given one relatively the given plane.
GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis)
 Replace the given object by an object, symmetrical to it relatively the given axis.
GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis)
 Create an object, symmetrical to the given one relatively the given axis.
GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint)
 Replace the given object by an object, symmetrical to it relatively the given point.
GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint)
 Create an object, symmetrical to the given one relatively the given point.
GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset)
 Replace the given object by its offset.
GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset)
 Create new object as offset of the given one.
GEOM_Object ProjectShapeCopy (in GEOM_Object theSource, in GEOM_Object theTarget)
 Create new object as projection of the given one on a 2D surface.
GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint, in double theFactor)
 Scale the given object by the factor.
GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint, in double theFactor)
 Scale the given object by the factor, creating its copy before the scaling.
GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject, in GEOM_Object thePoint, in double theFactorX, in double theFactorY, in double theFactorZ)
 Scale the given object by different factors along coordinate axes.
GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject, in GEOM_Object thePoint, in double theFactorX, in double theFactorY, in double theFactorZ)
 Scale the given object by different factors along coordinate axes, creating its copy before the scaling.
GEOM_Object PositionShape (in GEOM_Object theObject, in GEOM_Object theStartLCS, in GEOM_Object theEndLCS)
 Modify the Location of the given object by LCS.
GEOM_Object PositionShapeCopy (in GEOM_Object theObject, in GEOM_Object theStartLCS, in GEOM_Object theEndLCS)
 Modify the Location of the given object by LCS, creating its copy before the setting.
GEOM_Object PositionAlongPath (in GEOM_Object theObject, in GEOM_Object thePath, in double theDistance, in boolean theCopy, in boolean theReverse)
 Modify the Location of the given object by Path,.
GEOM_Object TransformLikeOtherCopy (in GEOM_Object theObject, in GEOM_Object theSample)
 Transform the shape in the same way what was used for the sample shape creation.
GEOM_Object RecomputeObject (in GEOM_Object theObject)
 Recompute the shape from its arguments.
boolean IsDone ()
 To know, if the operation was successfully performed.
void SetErrorCode (in string theErrorID)
 Set the operation error code.
string GetErrorCode ()
 Get the operation error code.
long GetStudyID ()
 Get ID of study, where the operation is defined.
void StartOperation ()
 Opens a new transaction.
void FinishOperation ()
 Closes the previously opened trasaction.
void AbortOperation ()
 Aborts the previously opened transaction.

Detailed Description

Definition at line 694 of file GEOM_Gen.idl.


Member Function Documentation

Aborts the previously opened transaction.

Closes the previously opened trasaction.

string GEOM::GEOM_IOperations::GetErrorCode ( ) [inherited]

Get the operation error code.

long GEOM::GEOM_IOperations::GetStudyID ( ) [inherited]

Get ID of study, where the operation is defined.

boolean GEOM::GEOM_IOperations::IsDone ( ) [inherited]

To know, if the operation was successfully performed.

Replace the given object by an object, symmetrical to it relatively the given axis.

Parameters:
theObjectThe object to be mirrored.
theAxisAxis of symmetry.
Returns:
theObject.

Create an object, symmetrical to the given one relatively the given axis.

Parameters:
theObjectThe object to be mirrored.
theAxisAxis of symmetry.
Returns:
New GEOM_Object, containing the mirrored object.

Replace the given object by an object, symmetrical to it relatively the given plane.

Parameters:
theObjectThe object to be mirrored.
thePlanePlane of symmetry.

Create an object, symmetrical to the given one relatively the given plane.

Parameters:
theObjectThe object to be mirrored.
thePlanePlane of symmetry.
Returns:
New GEOM_Object, containing the mirrored shape.

Replace the given object by an object, symmetrical to it relatively the given point.

Parameters:
theObjectThe object to be mirrored.
thePointPoint of symmetry.
Returns:
theObject.

Create an object, symmetrical to the given one relatively the given point.

Parameters:
theObjectThe object to be mirrored.
thePointPoint of symmetry.
Returns:
New GEOM_Object, containing the mirrored object.
GEOM_Object GEOM::GEOM_ITransformOperations::MultiRotate1D ( in GEOM_Object  theObject,
in GEOM_Object  theAxis,
in long  theNbTimes 
)

Rotate the given object around the given axis a given number times.

Rotation angle will be 2*PI/theNbTimes.

Parameters:
theObjectThe object to be rotated.
theAxisThe rotation axis.
theNbTimesQuantity of rotations to be done.
Returns:
New GEOM_Object, containing compound of all the shapes, obtained after each rotation.

Here is the caller graph for this function:

GEOM_Object GEOM::GEOM_ITransformOperations::MultiRotate2D ( in GEOM_Object  theObject,
in GEOM_Object  theAxis,
in double  theAngle,
in long  theNbTimes1,
in double  theStep,
in long  theNbTimes2 
)

Rotate the given object around the given axis on the given angle a given number times and multi-translate each rotation result.

Translation direction passes through center of gravity of rotated shape and its projection on the rotation axis.

Parameters:
theObjectThe object to be rotated.
theAxisRotation axis.
theAngleRotation angle in graduces.
theNbTimes1Quantity of rotations to be done.
theStepTranslation distance.
theNbTimes2Quantity of translations to be done.
Returns:
New GEOM_Object, containing compound of all the shapes, obtained after each transformation.

Here is the caller graph for this function:

GEOM_Object GEOM::GEOM_ITransformOperations::MultiTranslate1D ( in GEOM_Object  theObject,
in GEOM_Object  theVector,
in double  theStep,
in long  theNbTimes 
)

Translate the given object along the given vector a given number times.

Parameters:
theObjectThe object to be translated.
theVectorDirection of the translation.
theStepDistance to translate on.
theNbTimesQuantity of translations to be done.
Returns:
New GEOM_Object, containing compound of all the shapes, obtained after each translation.
GEOM_Object GEOM::GEOM_ITransformOperations::MultiTranslate2D ( in GEOM_Object  theObject,
in GEOM_Object  theVector1,
in double  theStep1,
in long  theNbTimes1,
in GEOM_Object  theVector2,
in double  theStep2,
in long  theNbTimes2 
)

Conseqently apply two specified translations to theObject specified number of times.

Parameters:
theObjectThe object to be translated.
theVector1Direction of the first translation.
theStep1Step of the first translation.
theNbTimes1Quantity of translations to be done along theVector1.
theVector2Direction of the second translation.
theStep2Step of the second translation.
theNbTimes2Quantity of translations to be done along theVector2.
Returns:
New GEOM_Object, containing compound of all the shapes, obtained after each translation.
GEOM_Object GEOM::GEOM_ITransformOperations::OffsetShape ( in GEOM_Object  theObject,
in double  theOffset 
)

Replace the given object by its offset.

Parameters:
theObjectThe base object for the offset.
theOffsetOffset value.
Returns:
theObject.
GEOM_Object GEOM::GEOM_ITransformOperations::OffsetShapeCopy ( in GEOM_Object  theObject,
in double  theOffset 
)

Create new object as offset of the given one.

Parameters:
theObjectThe base object for the offset.
theOffsetOffset value.
Returns:
New GEOM_Object, containing the offset object.
GEOM_Object GEOM::GEOM_ITransformOperations::PositionAlongPath ( in GEOM_Object  theObject,
in GEOM_Object  thePath,
in double  theDistance,
in boolean  theCopy,
in boolean  theReverse 
)

Modify the Location of the given object by Path,.

Parameters:
theObjectThe object to be displaced.
thePathWire or Edge along that the object will be translated.
theDistanceprogress of Path (0 = actual location, 1 = end of path location).
theCopyis a true or false parameter. true is to create a copy, false to move the object.
theReverseis a true or false parameter. true is to reverse direction, false is to move normal direction.
Returns:
New GEOM_Object, containing the displaced shape.
GEOM_Object GEOM::GEOM_ITransformOperations::PositionShape ( in GEOM_Object  theObject,
in GEOM_Object  theStartLCS,
in GEOM_Object  theEndLCS 
)

Modify the Location of the given object by LCS.

Parameters:
theObjectThe object to be displaced.
theStartLCSCoordinate system to perform displacement from it. If theStartLCS is NULL, displacement will be performed from global CS. If theObject itself is used as theStartLCS, its location will be changed to theEndLCS.
theEndLCSCoordinate system to perform displacement to it.
Returns:
theObject.

Modify the Location of the given object by LCS, creating its copy before the setting.

Parameters:
theObjectThe object to be displaced.
theStartLCSCoordinate system to perform displacement from it. If theStartLCS is NULL, displacement will be performed from global CS. If theObject itself is used as theStartLCS, its location will be changed to theEndLCS.
theEndLCSCoordinate system to perform displacement to it.
Returns:
New GEOM_Object, containing the displaced shape.

Create new object as projection of the given one on a 2D surface.

Parameters:
theSourceThe source object for the projection. It can be a point, edge or wire.
theTargetThe target object. It can be planar or cylindrical face.
Returns:
New GEOM_Object, containing the projection.

Recompute the shape from its arguments.

Parameters:
theObjectThe object to be recomputed.
Returns:
theObject.
GEOM_Object GEOM::GEOM_ITransformOperations::Rotate ( in GEOM_Object  theObject,
in GEOM_Object  theAxis,
in double  theAngle 
)

Rotate the given object around the given axis on the given angle.

Parameters:
theObjectThe object to be rotated.
theAxisRotation axis.
theAngleRotation angle in radians.
Returns:
theObject.
GEOM_Object GEOM::GEOM_ITransformOperations::RotateCopy ( in GEOM_Object  theObject,
in GEOM_Object  theAxis,
in double  theAngle 
)

Rotate the given object around the given axis on the given angle, creating its copy before the rotatation.

Parameters:
theObjectThe object to be rotated.
theAxisRotation axis.
theAngleRotation angle in radians.
Returns:
New GEOM_Object, containing the rotated object.
GEOM_Object GEOM::GEOM_ITransformOperations::RotateThreePoints ( in GEOM_Object  theObject,
in GEOM_Object  theCentPoint,
in GEOM_Object  thePoint1,
in GEOM_Object  thePoint2 
)

Rotate given object around vector perpendicular to plane containing three points.

Parameters:
theObjectThe object to be rotated.
theCentPointcentral point - the axis is the vector perpendicular to the plane containing the three points.
thePoint1,thePoint2- in a perpendicular plan of the axis.
Returns:
theObject.
GEOM_Object GEOM::GEOM_ITransformOperations::RotateThreePointsCopy ( in GEOM_Object  theObject,
in GEOM_Object  theCentPoint,
in GEOM_Object  thePoint1,
in GEOM_Object  thePoint2 
)

Rotate given object around vector perpendicular to plane containing three points.

Creating its copy before the rotatation.

Parameters:
theObjectThe object to be rotated.
theCentPointcentral point - the axis is the vector perpendicular to the plane containing the three points.
thePoint1,thePoint2- in a perpendicular plan of the axis.
Returns:
New GEOM_Object, containing the rotated object.
GEOM_Object GEOM::GEOM_ITransformOperations::ScaleShape ( in GEOM_Object  theObject,
in GEOM_Object  thePoint,
in double  theFactor 
)

Scale the given object by the factor.

Parameters:
theObjectThe object to be scaled.
thePointCenter point for scaling.
theFactorScaling factor value.
Returns:
theObject.
GEOM_Object GEOM::GEOM_ITransformOperations::ScaleShapeAlongAxes ( in GEOM_Object  theObject,
in GEOM_Object  thePoint,
in double  theFactorX,
in double  theFactorY,
in double  theFactorZ 
)

Scale the given object by different factors along coordinate axes.

Parameters:
theObjectThe object to be scaled.
thePointCenter point for scaling.
theFactorX,theFactorY,theFactorZScaling factors along each axis.
Returns:
theObject.
GEOM_Object GEOM::GEOM_ITransformOperations::ScaleShapeAlongAxesCopy ( in GEOM_Object  theObject,
in GEOM_Object  thePoint,
in double  theFactorX,
in double  theFactorY,
in double  theFactorZ 
)

Scale the given object by different factors along coordinate axes, creating its copy before the scaling.

Parameters:
theObjectThe object to be scaled.
thePointCenter point for scaling.
theFactorX,theFactorY,theFactorZScaling factors along each axis.
Returns:
New GEOM_Object, containing the scaled shape.
GEOM_Object GEOM::GEOM_ITransformOperations::ScaleShapeCopy ( in GEOM_Object  theObject,
in GEOM_Object  thePoint,
in double  theFactor 
)

Scale the given object by the factor, creating its copy before the scaling.

Parameters:
theObjectThe object to be scaled.
thePointCenter point for scaling.
theFactorScaling factor value.
Returns:
New GEOM_Object, containing the scaled shape.
void GEOM::GEOM_IOperations::SetErrorCode ( in string  theErrorID) [inherited]

Set the operation error code.

Parameters:
theErrorIDis a string describing the error occured
Note:
This method is supposed to be used only by interfaces inheriting from IOperations.

Opens a new transaction.

Transform the shape in the same way what was used for the sample shape creation.

Parameters:
theObjectThe object to be transformed.
theSampleThe object containing information about required transformation.
Note:
Implementation of this method is limited by multi-transformations now.
Internal method.
Returns:
New GEOM_Object, containing the transformed shape.
GEOM_Object GEOM::GEOM_ITransformOperations::TranslateDXDYDZ ( in GEOM_Object  theObject,
in double  theDX,
in double  theDY,
in double  theDZ 
)

Translate the given object along the vector, specified by its components.

Parameters:
theObjectThe object to be translated.
theDX,theDY,theDZComponents of translation vector.
Returns:
theObject.
GEOM_Object GEOM::GEOM_ITransformOperations::TranslateDXDYDZCopy ( in GEOM_Object  theObject,
in double  theDX,
in double  theDY,
in double  theDZ 
)

Translate the given object along the vector, specified by its components, creating its copy before the translation.

Parameters:
theObjectThe object to be translated.
theDX,theDY,theDZComponents of translation vector.
Returns:
New GEOM_Object, containing the translated object.

Translate the given object along the vector, specified by its end points.

Parameters:
theObjectThe object to be translated.
thePoint1Start point of translation vector.
thePoint2End point of translation vector.
Returns:
theObject.

Translate the given object along the vector, specified by its end points, creating its copy before the translation.

Parameters:
theObjectThe object to be translated.
thePoint1Start point of translation vector.
thePoint2End point of translation vector.
Returns:
New GEOM_Object, containing the translated object.

Translate the given object along the given vector.

Parameters:
theObjectThe object to be translated.
theVectorTranslation vector, giving both direction and distance.
Returns:
theObject.

Translate the given object along the given vector, creating its copy before the translation.

Parameters:
theObjectThe object to be translated.
theVectorTranslation vector, giving both direction and distance.
Returns:
New GEOM_Object, containing the translated object.
GEOM_Object GEOM::GEOM_ITransformOperations::TranslateVectorDistance ( in GEOM_Object  theObject,
in GEOM_Object  theVector,
in double  theDistance,
in boolean  theCopy 
)

Translate the given object along the given vector on given distance, creating its copy before the translation.

Parameters:
theObjectThe object to be translated.
theVectorTranslation vector, giving a direction.
theDistanceTranslation distance, giving a distance.
theCopyTranslation copy, creating its copy if true.
Returns:
New GEOM_Object, containing the translated object.

The documentation for this interface was generated from the following file: