All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIMf3DAxisSystemFactory

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

interface CATIMf3DAxisSystemFactory

Interface to create an axis system.
Role:This interface enables you to create an axis system in a 3D Shape. You can retrieve or modify the newly axis system characteristics with the interface. You can also set it the current one with the interface.

All the values (origin and vector coordinates, mathematical axis system and parameter values) are expressed in the absolute axis system. If some values are invalid (a null vector or colinear vectors) the axis system is even created, but its update generates an error.

This interface is implemented by the specification container of the 3D Shape.

Method Index

o CreateAxisSystem(CATMathAxis&,CATIMf3DAxisSystem_var&): Creates an axis system from a mathematical axis system.
o CreateAxisSystem(CATICkeParm_var[4][3],CATIMf3DAxisSystem_var&): Creates an axis system from knowledge parameters.
o CreateAxisSystem(CATIMf3DAxisSystem_var&,CATIMf3DAxisSystem_var&): Creates an axis system from another axis system.
o CreateAxisSystem(CATMathPoint&,CATMathVector&,CATMathVector&,CATIMf3DAxisSystem_var&): Creates an axis system from one point and 2 vectors.
o CreateExplicitAxisSystem(CATIMf3DAxisSystem_var&): Creates an explicit axis system.

Methods

o CreateAxisSystem

public virtual CreateAxisSystem(	const	`iMathAxis`,
		`oAxisSystem`)

Creates an axis system from a mathematical axis system.
Role:This method creates an axis system from a mathematical axis system. The new axis system is normalized and orthogonal. Its orientation (right or left-handed) depends on the iMathAxis orientation.

Parameters:

iMathAxis: The mathematical axis system.
oAxisSystem: The new axis system. Its type is CATAxisSystemStandard (

o CreateAxisSystem

public virtual CreateAxisSystem(	const	`iCoord`,
		`oAxisSystem`)

Creates an axis system from knowledge parameters.
Role:These parameters are twelve and represent the coordinates of the origin and the three axes of the axis system.
An axis system has always twelve parameters as internal data. This way to create an axis system enables you to affect your own parameters to define the new axis system. But attention, these knowledge parameters will be aggregated by the new axis system and so, will be deleted with the axis system destruction. Consequently, no parameter must already have a parent. In this case, the method returns an error and the axis system is not created.

Parameters:

iCoord

Twelve parameters representing the three coordinates (x,y,z) of :

The origin point
Three vectors,the X,Y Z axis respectively

If the axis directions are not orthogonal, the parameter values will be modified (by the update operation) to form an orthogonal axis system.

oAxisSystem

The new axis system. Its type is CATAxisSystemStandard (

Returns:

E_INVALIDARG: one parameter is null or has already a parent, oAxisSystem is not valid
E_FAIL: Internal error, oAxisSystem is not valid
S_OK: oAxisSystem is valid

o CreateAxisSystem

public virtual CreateAxisSystem(	const	`iAxisSystemToCopy`,
		`oAxisSystem`)

Creates an axis system from another axis system.

Parameters:

iAxisSystemToCopy: The axis system to copy
oAxisSystem: The new axis system

o CreateAxisSystem

public virtual CreateAxisSystem(	const	`iOriginPoint`,
	const	`iVectorX`,
	const	`iVectorY`,
		`oAxisSystem`)

Creates an axis system from one point and 2 vectors.
Role:This method creates an axis system from one point, the origin, and 2 vectors for the axis directions. The third direction will be automatically computed to define a right-handed axis system. The axis directions are computed as follows:

X axis= iVectorX (normalized if necessary)
Y axis is normalized and belongs to the plane (iVectorX,iVectorY) to be X axis orthogonal.
Z axis = The vectorial product of the X axis by the Y axis (X axis ^ Y axis )

Parameters:

iOriginPoint: The mathematical point of the origin.
iVectorX: The mathematical vector of the X axis.
iVectorY: The mathematical vector of the Y axis.
oAxisSystem: The new axis system which is normalized, orthogonal and right-handed. Its type is CATAxisSystemStandard (

o CreateExplicitAxisSystem

public virtual CreateExplicitAxisSystem( oAxisSystem)

Creates an explicit axis system.
Role:An explicit feature is an "isolated" feature. It means that its geometry (CATBody) is fixed and you cannot change the axis system characteristics.
The new axis system is located at the origin 0,0,0 and its three axis directions are as follows:

X axis is 1,0,0
Y axis is 0,1,0
Z axis is 0,0,1

Parameters:

oAxisSystem: The new explicit axis system. Its type is CATAxisSystemExplicit (

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