All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIMf3DAxisSystemManager

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

CATIMf3DAxisSystemManager

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

interface CATIMf3DAxisSystemManager

Interface to manage the axis systems.
Role:This interface enables you:

To know all the axis systems created by the CATIMf3DAxisSystemFactory interface into 3D Shape. See the GetAxisSystems method.
To set or retrieve the current axis system. See SetCurrentAxisSystem and GetCurrentAxisSystem respectively.
To translate the coordinates of a point ( ConvertPointCoordinates ) or a vector ( ConvertVectorCoordinates ) in the current axis system.

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

See also:: CATIMf3DAxisSystem, CATIMf3DAxisSystemFactory

Method Index

o ConvertPointCoordinates(CATBoolean,CATMathPoint&,CATMathPoint&): Converts point coordinates in the current axis system.
o ConvertVectorCoordinates(CATBoolean,CATMathVector&,CATMathVector&): Converts vector coordinates in the current axis system.
o GetAxisSystems(CATLISTV(CATIMf3DAxisSystem_var)&): Retrieves all the axis systems of the 3D Shape.
o GetCurrentAxisSystem(CATIMf3DAxisSystem_var&): Retrieves the current axis system.
o SetCurrentAxisSystem(CATIMf3DAxisSystem_var&): Sets an axis system as the current one.

Methods

o ConvertPointCoordinates

public virtual HRESULT ConvertPointCoordinates(	const CATBoolean	`iAbsoluteToCurrent`,
	const CATMathPoint&	`iPointToConvert`,
	CATMathPoint&	`oConvertedPoint`) const=0

Converts point coordinates in the current axis system.

Parameters:

iAbsoluteToCurrent

If TRUE, converts the coordinates from the absolute axis system to the current axis system.
If FALSE, converts the coordinates from the current axis systen to the absolute axis system.

iPointToConvert

The mathematical point to convert.

oConvertedPoint

The converted mathematical point.

o ConvertVectorCoordinates

public virtual HRESULT ConvertVectorCoordinates(	const CATBoolean	`iAbsoluteToCurrent`,
	const CATMathVector&	`iVectorToConvert`,
	CATMathVector&	`oConvertedVector`) const=0

Converts vector coordinates in the current axis system.

Parameters:

iAbsoluteToCurrent

If TRUE, converts the coordinates from the absolute axis system to the current axis system.
If FALSE, converts the coordinates from the current axis systen to the absolute axis system.

iVectorToConvert

The mathematical vector to convert.

oConvertedVector

The converted mathematical vector.

o GetAxisSystems

public virtual HRESULT GetAxisSystems( CATLISTV(CATIMf3DAxisSystem_var)& oAxisSystemList) const =0

Retrieves all the axis systems of the 3D Shape.

Parameters:

oAxisSystemList: The axis system list.

o GetCurrentAxisSystem

public virtual HRESULT GetCurrentAxisSystem( CATIMf3DAxisSystem_var& oCurrentAxisSystem) const=0

Retrieves the current axis system.

Parameters:

oCurrentAxisSystem: The current axis system. If the value is NULL_var, there is no current axis system.

o SetCurrentAxisSystem

public virtual HRESULT SetCurrentAxisSystem( const CATIMf3DAxisSystem_var& iAxisSystem) const =0

Sets an axis system as the current one.
Role:This method enables you to set an axis system as current. It guarantees that only one axis system is current in the 3D Shape. Set an axis system the current one can be useful:

To use the ConvertPointCoordinates and ConvertVectorCoordinates to translate the point/vector coordinates in this axis system.
In an interactive session, to control the current axis system which is used by some commands such as Point. These commands can display points (or vectors ) coordinates in the current axis system.

Parameters:

iAxisSystem: The new current axis system. If the value is NULL_var, there is no current axis system, the coordinates are always displayed in the absolute axis system.

Returns:

E_FAIL if the iAxisSystem is not orthogonal - CATAxisSystemIsDirect

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