All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseAffinity

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

CATIGSMUseAffinity

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

interface CATIGSMUseAffinity

Interface to affinity feature.
Role: Allows you to acess data of Affinity feature created by using an element, an axis and three ratios.

See also:: CATIGSMUseFactory.CreateAffinity

Method Index

o GetAxis(CATMathAxis&): Gets the reference axis system (always direct).
o GetAxisFirstDirection(CATIMmiMechanicalFeature_var&): Gets the first direction of the reference axis system (always direct).
o GetAxisOrigin(CATIMmiMechanicalFeature_var&): Gets the origin of the reference axis system (always direct).
o GetAxisPlane(CATIMmiMechanicalFeature_var&): Gets the xy plane of the reference axis system (always direct).
o GetCreationMode(CATBoolean&): Gets the Creation Mode.
o GetElemToTransform(CATIMmiMechanicalFeature_var&): Gets the feature to transform.
o GetRatios(double&,double&,double&): Gets the ratios of the affinity.
o GetRatios(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&): Gets the ratios of the affinity.
o SetAxisFirstDirection(CATIMmiMechanicalFeature_var): Sets the first direction of the reference axis system (always direct).
o SetAxisOrigin(CATIMmiMechanicalFeature_var): Sets the origin point of the reference axis system (always direct).
o SetAxisPlane(CATIMmiMechanicalFeature_var): Sets the reference plane of the reference axis system (always direct).
o SetCreationMode(CATBoolean): Sets the Creation Mode.
o SetElemToTransform(CATIMmiMechanicalFeature_var): Sets the feature to transform.
o SetRatios(double,double,double): Sets the ratios of the affinity.
o SetRatios(CATICkeParm_var,CATICkeParm_var,CATICkeParm_var): Sets the ratios of the affinity.

Methods

o GetAxis

public virtual HRESULT GetAxis( CATMathAxis& oAxis) = 0

Gets the reference axis system (always direct).

Parameters:

oAxis: reference axis system

o GetAxisFirstDirection

public virtual HRESULT GetAxisFirstDirection( CATIMmiMechanicalFeature_var& oElem) = 0

Gets the first direction of the reference axis system (always direct).

Parameters:

oElem: first direction (x) of the reference axis system

o GetAxisOrigin

public virtual HRESULT GetAxisOrigin( CATIMmiMechanicalFeature_var& oElem) = 0

Gets the origin of the reference axis system (always direct).

Parameters:

oElem: origin point of the reference axis system

o GetAxisPlane

public virtual HRESULT GetAxisPlane( CATIMmiMechanicalFeature_var& oElem) = 0

Gets the xy plane of the reference axis system (always direct).

Parameters:

oElem: xy plane of the reference axis system

o GetCreationMode

public virtual HRESULT GetCreationMode( CATBoolean& oMode)= 0

Gets the Creation Mode.

Parameters:

oMode: flag for transformation type (creation or modification)

o GetElemToTransform

public virtual HRESULT GetElemToTransform( CATIMmiMechanicalFeature_var& oElem) = 0

Gets the feature to transform.

Parameters:

oElem: feature to transform

o GetRatios

public virtual HRESULT GetRatios(	double&	`oRatX`,
	double&	`oRatY`,
	double&	`oRatZ`) = 0

Gets the ratios of the affinity.

Parameters:

iRatX: ratio in the first direction
iRatY: ratio in the second direction
iRatZ: ratio in the third direction

o GetRatios

public virtual HRESULT GetRatios(	CATICkeParm_var&	`oRatX`,
	CATICkeParm_var&	`oRatY`,
	CATICkeParm_var&	`oRatZ`) = 0

Gets the ratios of the affinity.

Parameters:

oRatX: ratio in the first direction
oRatY: ratio in the second direction
oRatZ: ratio in the third direction

o SetAxisFirstDirection

public virtual HRESULT SetAxisFirstDirection( const CATIMmiMechanicalFeature_var iElem) = 0

Sets the first direction of the reference axis system (always direct).

Parameters:

iElem: new first direction (x) of the reference axis system

o SetAxisOrigin

public virtual HRESULT SetAxisOrigin( const CATIMmiMechanicalFeature_var iElem) = 0

Sets the origin point of the reference axis system (always direct).

Parameters:

iElem: new origin point of the reference axis system

o SetAxisPlane

public virtual HRESULT SetAxisPlane( const CATIMmiMechanicalFeature_var iElem) = 0

Sets the reference plane of the reference axis system (always direct).

Parameters:

iElem: new xy plane of the reference axis system

o SetCreationMode

public virtual HRESULT SetCreationMode( const CATBoolean iMode)= 0

Sets the Creation Mode.

Parameters:

iMode: flag for transformation type (creation or modification)

o SetElemToTransform

public virtual HRESULT SetElemToTransform( const CATIMmiMechanicalFeature_var iElem) = 0

Sets the feature to transform.

Parameters:

iElem: new feature to transform

o SetRatios

public virtual HRESULT SetRatios(	double	`RatX`,
	double	`RatY`,
	double	`RatZ`) = 0

Sets the ratios of the affinity.

Parameters:

iRatX: ratio in the first direction
iRatY: ratio in the second direction
iRatZ: ratio in the third direction

o SetRatios

public virtual HRESULT SetRatios(	const CATICkeParm_var	`iRatX`,
	const CATICkeParm_var	`RatY`,
	const CATICkeParm_var	`RatZ`) = 0

Sets the ratios of the affinity.

Parameters:

iRatX: ratio in the first direction
iRatY: ratio in the second direction
iRatZ: ratio in the third direction

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