All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMModelerBaseInterfaces Interface CATIMovable

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

interface CATIMovable

Interface to manage movable objects.
Role: A movable object is an object that is intended to define its coordinates in a particular 3D-coordinates system.
This interface provides methods to retrieve or set the relative position of the item, in the coordinate space of the context.
The context can be a movable object. There are two particular contexts : the default one and the global one (which is not a movable).

Method Index

o ApplyTransformation(CATMathTransformation&,CATIMovable_var&): Applies a transformation in the 3D-coordinates space of the context.
o GetAbsPosition(CATMathTransformation&): Retrieves the position in a global context.
o GetPosition(CATIMovable_var&): Retrieves the position in a given context.
o SetAbsPosition(CATMathTransformation&): Sets position in an absolute 3D-coordinates space (global context).
o SetPosition(CATMathTransformation&,CATIMovable_var&): Sets the relative position in a given context.

Methods

o ApplyTransformation

public virtual ApplyTransformation(	const	`iTransfo`,
	const	`iPosObj`)

Applies a transformation in the 3D-coordinates space of the context.

Parameters:

iTransfo: The transformation to apply.
iPosObj: The movable context to define position.
If NULL, it uses the default context.

Returns:

S_OK if the transformation was successfully applied
E_FAIL otherwise

o GetAbsPosition

public virtual GetAbsPosition( oPos)

Retrieves the position in a global context.

Parameters:

oPos: The position of the movable object

Returns:

S_OK if the position was successfully retrieved
E_FAIL otherwise

o GetPosition

public virtual GetPosition( const iPosObj)

Retrieves the position in a given context.

Parameters:

iPosObj: The movable context to define position.
If NULL, it uses the default context.

Returns:

The CATMathTransformation matrix of the position

o SetAbsPosition

public virtual SetAbsPosition( const iPos)

Sets position in an absolute 3D-coordinates space (global context).

Parameters:

iPos: The position to set.

Returns:

S_OK if the position was successfully set
E_FAIL otherwise

o SetPosition

public virtual SetPosition(	const	`iTransfo`,
	const	`iPosObj`)

Sets the relative position in a given context.
Note: If the context is not defined, it uses the default context.

Parameters:

iTransfo: The position to set.
iPosObj: The movable context to define position.
If NULL, it uses the default context.

Returns:

S_OK if the position was successfully set
E_FAIL otherwise

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