GEOM.GEOM_ITransformOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_ITransformOperations:

Public Member Functions
GEOM_Object	TranslateTwoPoints (in GEOM_Object theObject, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
GEOM_Object	TranslateTwoPointsCopy (in GEOM_Object theObject, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
GEOM_Object	TranslateDXDYDZ (in GEOM_Object theObject, in double theDX, in double theDY, in double theDZ)
GEOM_Object	TranslateDXDYDZCopy (in GEOM_Object theObject, in double theDX, in double theDY, in double theDZ)
GEOM_Object	TranslateVector (in GEOM_Object theObject, in GEOM_Object theVector)
GEOM_Object	TranslateVectorCopy (in GEOM_Object theObject, in GEOM_Object theVector)
GEOM_Object	TranslateVectorDistance (in GEOM_Object theObject, in GEOM_Object theVector, in double theDistance, in boolean theCopy)
GEOM_Object	MultiTranslate1D (in GEOM_Object theObject, in GEOM_Object theVector, in double theStep, in long theNbTimes)
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)
GEOM_Object	RotateThreePoints (in GEOM_Object theObject, in GEOM_Object theCentPoint, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
GEOM_Object	RotateThreePointsCopy (in GEOM_Object theObject, in GEOM_Object theCentPoint, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
GEOM_Object	Rotate (in GEOM_Object theObject, in GEOM_Object theAxis, in double theAngle)
GEOM_Object	RotateCopy (in GEOM_Object theObject, in GEOM_Object theAxis, in double theAngle)
GEOM_Object	MultiRotate1D (in GEOM_Object theObject, in GEOM_Object theAxis, in long theNbTimes)
GEOM_Object	MultiRotate2D (in GEOM_Object theObject, in GEOM_Object theAxis, in double theAngle, in long theNbTimes1, in double theStep, in long theNbTimes2)
GEOM_Object	MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane)
GEOM_Object	MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane)
GEOM_Object	MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis)
GEOM_Object	MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis)
GEOM_Object	MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint)
GEOM_Object	MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint)
GEOM_Object	OffsetShape (in GEOM_Object theObject, in double theOffset)
GEOM_Object	OffsetShapeCopy (in GEOM_Object theObject, in double theOffset)
GEOM_Object	ProjectShapeCopy (in GEOM_Object theSource, in GEOM_Object theTarget)
GEOM_Object	ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint, in double theFactor)
GEOM_Object	ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint, in double theFactor)
GEOM_Object	ScaleShapeAlongAxes (in GEOM_Object theObject, in GEOM_Object thePoint, in double theFactorX, in double theFactorY, in double theFactorZ)
GEOM_Object	ScaleShapeAlongAxesCopy (in GEOM_Object theObject, in GEOM_Object thePoint, in double theFactorX, in double theFactorY, in double theFactorZ)
GEOM_Object	PositionShape (in GEOM_Object theObject, in GEOM_Object theStartLCS, in GEOM_Object theEndLCS)
GEOM_Object	PositionShapeCopy (in GEOM_Object theObject, in GEOM_Object theStartLCS, in GEOM_Object theEndLCS)
GEOM_Object	PositionAlongPath (in GEOM_Object theObject, in GEOM_Object thePath, in double theDistance, in boolean theCopy, in boolean theReverse)
GEOM_Object	TransformLikeOtherCopy (in GEOM_Object theObject, in GEOM_Object theSample)
GEOM_Object	RecomputeObject (in GEOM_Object theObject)
boolean	IsDone ()
void	SetErrorCode (in string theErrorID)
string	GetErrorCode ()
long	GetStudyID ()
void	StartOperation ()
void	FinishOperation ()
void	AbortOperation ()

---

Member Function Documentation

GEOM_Object GEOM.GEOM_ITransformOperations.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.

Parameters:

theObject	The object to be translated.
thePoint1	Start point of translation vector.
thePoint2	End point of translation vector.

Returns:

theObject.

GEOM_Object GEOM.GEOM_ITransformOperations.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.

Parameters:

theObject	The object to be translated.
thePoint1	Start point of translation vector.
thePoint2	End point of translation vector.

Returns:

New GEOM_Object, containing the translated object.

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:

theObject	The object to be translated.
theDX,theDY,theDZ	Components 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:

theObject	The object to be translated.
theDX,theDY,theDZ	Components of translation vector.

Returns:

New GEOM_Object, containing the translated object.

GEOM_Object GEOM.GEOM_ITransformOperations.TranslateVector	(	in GEOM_Object	theObject,
		in GEOM_Object	theVector
	)

Translate the given object along the given vector.

Parameters:

theObject	The object to be translated.
theVector	Translation vector, giving both direction and distance.

Returns:

theObject.

GEOM_Object GEOM.GEOM_ITransformOperations.TranslateVectorCopy	(	in GEOM_Object	theObject,
		in GEOM_Object	theVector
	)

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

Parameters:

theObject	The object to be translated.
theVector	Translation 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:

theObject	The object to be translated.
theVector	Translation vector, giving a direction.
theDistance	Translation distance, giving a distance.
theCope	Translation copy, creating its copy if true.

Returns:

New GEOM_Object, containing the translated object.

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:

theObject	The object to be translated.
theVector	Direction of the translation.
theStep	Distance to translate on.
theNbTimes	Quantity 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:

theObject	The object to be translated.
theVector1	Direction of the first translation.
theStep1	Step of the first translation.
theNbTimes1	Quantity of translations to be done along theVector1.
theVector2	Direction of the second translation.
theStep2	Step of the second translation.
theNbTimes2	Quantity 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.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:

theObject	The object to be rotated.
theCentPoint	central point - the axis is the vector perpendicular to the plane containing the three points.
thePoint1	and 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:

theObject	The object to be rotated.
theCentPoint	central point - the axis is the vector perpendicular to the plane containing the three points.
thePoint1	and thePoint2 - in a perpendicular plan of the axis.

Returns:

New GEOM_Object, containing the rotated object.

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:

theObject	The object to be rotated.
theAxis	Rotation axis.
theAngle	Rotation 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:

theObject	The object to be rotated.
theAxis	Rotation axis.
theAngle	Rotation angle in radians.

Returns:

New GEOM_Object, containing the rotated 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:

theObject	The object to be rotated.
theAxis	The rotation axis.
theNbTimes	Quantity of rotations to be done.

Returns:

New GEOM_Object, containing compound of all the shapes, obtained after each rotation.

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:

theObject	The object to be rotated.
theAxis	Rotation axis.
theAngle	Rotation angle in graduces.
theNbTimes1	Quantity of rotations to be done.
theStep	Translation distance.
theNbTimes2	Quantity of translations to be done.

Returns:

New GEOM_Object, containing compound of all the shapes, obtained after each transformation.

GEOM_Object GEOM.GEOM_ITransformOperations.MirrorPlane	(	in GEOM_Object	theObject,
		in GEOM_Object	thePlane
	)

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

Parameters:

theObject	The object to be mirrored.
thePlane	Plane of symmetry.

GEOM_Object GEOM.GEOM_ITransformOperations.MirrorPlaneCopy	(	in GEOM_Object	theObject,
		in GEOM_Object	thePlane
	)

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

Parameters:

theObject	The object to be mirrored.
thePlane	Plane of symmetry.

Returns:

New GEOM_Object, containing the mirrored shape.

GEOM_Object GEOM.GEOM_ITransformOperations.MirrorAxis	(	in GEOM_Object	theObject,
		in GEOM_Object	theAxis
	)

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

Parameters:

theObject	The object to be mirrored.
theAxis	Axis of symmetry.

Returns:

theObject.

GEOM_Object GEOM.GEOM_ITransformOperations.MirrorAxisCopy	(	in GEOM_Object	theObject,
		in GEOM_Object	theAxis
	)

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

Parameters:

theObject	The object to be mirrored.
theAxis	Axis of symmetry.

Returns:

New GEOM_Object, containing the mirrored object.

GEOM_Object GEOM.GEOM_ITransformOperations.MirrorPoint	(	in GEOM_Object	theObject,
		in GEOM_Object	thePoint
	)

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

Parameters:

theObject	The object to be mirrored.
thePoint	Point of symmetry.

Returns:

theObject.

GEOM_Object GEOM.GEOM_ITransformOperations.MirrorPointCopy	(	in GEOM_Object	theObject,
		in GEOM_Object	thePoint
	)

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

Parameters:

theObject	The object to be mirrored.
thePoint	Point of symmetry.

Returns:

New GEOM_Object, containing the mirrored object.

GEOM_Object GEOM.GEOM_ITransformOperations.OffsetShape	(	in GEOM_Object	theObject,
		in double	theOffset
	)

Replace the given object by its offset.

Parameters:

theObject	The base object for the offset.
theOffset	Offset 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:

theObject	The base object for the offset.
theOffset	Offset value.

Returns:

New GEOM_Object, containing the offset object.

GEOM_Object GEOM.GEOM_ITransformOperations.ProjectShapeCopy	(	in GEOM_Object	theSource,
		in GEOM_Object	theTarget
	)

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

Parameters:

theSource	The source object for the projection. It can be a point, edge or wire.
theTarget	The target object. It can be planar or cylindrical face.

Returns:

New GEOM_Object, containing the projection.

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:

theObject	The object to be scaled.
thePoint	Center point for scaling.
theFactor	Scaling factor value.

Returns:

theObject.

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:

theObject	The object to be scaled.
thePoint	Center point for scaling.
theFactor	Scaling factor value.

Returns:

New GEOM_Object, containing the scaled shape.

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:

theObject	The object to be scaled.
thePoint	Center point for scaling.
theFactorX,theFactorY,theFactorZ	Scaling 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:

theObject	The object to be scaled.
thePoint	Center point for scaling.
theFactorX,theFactorY,theFactorZ	Scaling factors along each axis.

Returns:

New GEOM_Object, containing the scaled 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:

theObject	The object to be displaced.
theStartLCS	Coordinate 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.
theEndLCS	Coordinate system to perform displacement to it.

Returns:

theObject.

GEOM_Object GEOM.GEOM_ITransformOperations.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.

Parameters:

theObject	The object to be displaced.
theStartLCS	Coordinate 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.
theEndLCS	Coordinate system to perform displacement to it.

Returns:

New GEOM_Object, containing the displaced shape.

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:

theObject	The object to be displaced.
thePath	Wire or Edge along that the object will be translated.
theDistance	progress of Path (0 = actual location, 1 = end of path location).
theCopy	is a true or false parameter. true is to create a copy, false to move the object.
theCopy	is 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.TransformLikeOtherCopy	(	in GEOM_Object	theObject,
		in GEOM_Object	theSample
	)

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

Parameters:

theObject	The object to be transformed.
theSample	The 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.RecomputeObject

(

in GEOM_Object

theObject

)

Recompute the shape from its arguments.

Parameters:

theObject

The object to be recomputed.

Returns:

theObject.

boolean GEOM.GEOM_IOperations.IsDone

(

)

[inherited]

To know, if the operation was successfully performed

void GEOM.GEOM_IOperations.SetErrorCode

(

in string

theErrorID

)

[inherited]

Set the operation error code

Parameters:

theErrorID

is a string describing the error occured

Note:

This method is supposed to be used only by interfaces inheriting from IOperations.

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

void GEOM.GEOM_IOperations.StartOperation

(

)

[inherited]

Opens a new transaction

void GEOM.GEOM_IOperations.FinishOperation

(

)

[inherited]

Closes the previously opened trasaction

void GEOM.GEOM_IOperations.AbortOperation

(

)

[inherited]

Aborts the previously opened transaction