All Frameworks Class Hierarchy This Framework Indexes Previous Next

ProductStructureUseItf Interface CATIPrdInstanceFixityManagement

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

interface CATIPrdInstanceFixityManagement

Interface to manage 3DInstance.
Role: This interface allow to manage the fixity property of a 3DInstance.
Such property is checked inside modeler code to forbid 3DMatrix attribute valuation. example : will return E_FAIL if the 3DInstance is fixed. and also Mechanical Update Engine consider a 3DInstance fixed as a fix object. Such property has also no impact on Repositionable property, or ability to overload occurrence position. (see @hRef CATIPrdRepositionable & CATIPrdRepositioned) Interface is implemented by the VPMInstance, also called 3DInstance because own a 3DMatrix.

Method Index

o IsFixed(): Returns the Fixity Property of a 3DInstance.
o SetAsFix(): Makes a 3D Instance as Fix.
o SetAsMovable(): Makes a 3D Instance as Movable.

Methods

o IsFixed

public virtual IsFixed(

)

Returns the Fixity Property of a 3DInstance.

Returns:

TRUE 3DInstance is fixed.
FALSE 3DInstance is movable.

o SetAsFix

public virtual SetAsFix(

)

Makes a 3D Instance as Fix.
Role: This Method makes this 3DInstance as Fix.

Returns:

S_OK 3DInstance has been sucessfully set as fix, or was already fixed.
E_FAIL if internal error occurred, or 3DInstance could not be set as fix.

o SetAsMovable

public virtual SetAsMovable(

)

Makes a 3D Instance as Movable.
Role: This Method makes this 3DInstance as Movable.

Returns:

S_OK 3DInstance has been sucessfully set as movable, or was already movable.
E_FAIL if internal error occurred, or 3DInstance could not be set as movable.

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