All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUse3DFurtiveGrid

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

interface CATIGSMUse3DFurtiveGrid

3D Furtive Grid Feature.
Role: allows to manipulate the data of 3D Furtive Grid.
The 3D Furtive Grid is constituated of three WorkOnSupport
* Each WorkOnSupport is constituated by a Cartesian Grid Plane
* When the current view becomes parallele to one of the defined cartesian grid plane the grid is displayed
* Each grid as the attribute Selectable, Furtive, xxxx
* Stepping, Labels,. position can be modified for each Cartesian Grid

See also:
See also:: ,

Method Index

o Get3DFurtiveGridLocalAxisSystem(CATIMmiMechanicalFeature_var&): Gets Axis Syrtem for Local 3D Furtive Grid definition.
o Get3DFurtiveGridWorkOnSupport(CATIGSMUseWorkingSupport_var&,int): Gets 3D Furtive Grid differnet WorkOnSupport.
o GetFurtivity(): Gets the grids furtivity.
o GetGridOrigin(CATIMmiMechanicalFeature_var&): Gets the 3D Grid origin, with offsets applied to it.
o GetOffsetValueX(CATICkeParm_var&): Gets the offset applied to 3D grid origin, along X direction.
o GetOffsetValueY(CATICkeParm_var&): Gets the offset applied to 3D grid origin, along Y direction.
o GetOffsetValueZ(CATICkeParm_var&): Gets the offset applied to 3D grid origin, along Z direction.
o GetOrigin(CATIMmiMechanicalFeature_var&): Gets 3D Grid origin.
o GetPosition(): Gets position.
o GetType(): Gets type.
o Set3DFurtiveGridLocalAxisSystem(CATIMmiMechanicalFeature_var&): Sets Axis Syrtem for Local 3D Furtive Grid definition.
o Set3DFurtiveGridWorkOnSupport(CATIGSMUseWorkingSupport_var&,int): Set 3D Furtive Grid differnet WorkOnSupport.
o SetFurtivity(int): Sets the grids furtivity.
o SetGridOrigin(CATIMmiMechanicalFeature_var&): Sets the 3D Grid origin, with offsets applied to it.
o SetOffsetValueX(CATICkeParm_var&): Sets the offset applied to 3D grid origin, along X direction.
o SetOffsetValueY(CATICkeParm_var&): Sets the offset applied to 3D grid origin, along Y direction.
o SetOffsetValueZ(CATICkeParm_var&): Sets the offset applied to 3D grid origin, along Z direction.
o SetOrigin(CATIMmiMechanicalFeature_var&): Sets 3D Grid origin.
o SetPosition(int): Sets position.
o SetType(enum CATIGSMUseCartesianGrid::CATGSMGridType): Sets type.

Methods

o Get3DFurtiveGridLocalAxisSystem

public virtual Get3DFurtiveGridLocalAxisSystem( oAxisSystem)

Gets Axis Syrtem for Local 3D Furtive Grid definition.

Parameters:

oAxisSystem: Return local Axis System if NULL_var = 3D Furtive Grid is define related reference plane (XY,YZ ,ZX) Note: Only one reference 3D Furtive Grid can be defined in a CATPart

o Get3DFurtiveGridWorkOnSupport

public virtual Get3DFurtiveGridWorkOnSupport(		`oWOS`,
		`iRank`)

Gets 3D Furtive Grid differnet WorkOnSupport.

Parameters:

oWos: Work on Support
iRank: Number of related Wos

o GetFurtivity

public virtual GetFurtivity(

)

Gets the grids furtivity.
Returned value : = 0 Grids not furtive
: = 1 Grids furtive

o GetGridOrigin

public virtual GetGridOrigin( oManipulatedOrigin)

Gets the 3D Grid origin, with offsets applied to it.

Parameters:

oManipulatedOrigin: ManipulatedOrigin

o GetOffsetValueX

public virtual GetOffsetValueX( oOffsetValueX)

Gets the offset applied to 3D grid origin, along X direction.

Parameters:

oOffsetValueX: OffsetValueX

o GetOffsetValueY

public virtual GetOffsetValueY( oOffsetValueY)

Gets the offset applied to 3D grid origin, along Y direction.

Parameters:

oOffsetValueY: OffsetValueY

o GetOffsetValueZ

public virtual GetOffsetValueZ( oOffsetValueZ)

Gets the offset applied to 3D grid origin, along Z direction.

Parameters:

oOffsetValueZ: OffsetValueZ

o GetOrigin

public virtual GetOrigin( oOrigin)

Gets 3D Grid origin.

Parameters:

oOrigin: Origin

o GetPosition

public virtual GetPosition(

)

Gets position.
Returned value : Position number from 1 to 8

o GetType

public virtual GetType(

)

Gets type.
Returned value : enum {CATGSMGridFinite, CATGSMGridInfinite}

o Set3DFurtiveGridLocalAxisSystem

public virtual Set3DFurtiveGridLocalAxisSystem( const iAxisSystem)

Sets Axis Syrtem for Local 3D Furtive Grid definition.

Parameters:

iAxisSystem: Set iAxisSystem as Axis for the 3D Furtive Grid

o Set3DFurtiveGridWorkOnSupport

public virtual Set3DFurtiveGridWorkOnSupport(	const	`iWos`,
		`iRank`)

Set 3D Furtive Grid differnet WorkOnSupport.

Parameters:

iWos: Work on Support
iRank: Number of related Wos

o SetFurtivity

public virtual SetFurtivity( const iFurtivity =1)

Sets the grids furtivity.

Parameters:

iFurtivity: iFurtivity : = 0 Grids not furtive
: = 1 Grids furtive

o SetGridOrigin

public virtual SetGridOrigin( const iManipulatedOrigin)

Sets the 3D Grid origin, with offsets applied to it.

Parameters:

iManipulatedOrigin: ManipulatedOrigin

o SetOffsetValueX

public virtual SetOffsetValueX( const iOffsetValueX)

Sets the offset applied to 3D grid origin, along X direction.

Parameters:

iOffsetValueX: OffsetValueX

o SetOffsetValueY

public virtual SetOffsetValueY( const iOffsetValueY)

Sets the offset applied to 3D grid origin, along Y direction.

Parameters:

iOffsetValueY: OffsetValueY

o SetOffsetValueZ

public virtual SetOffsetValueZ( const iOffsetValueZ)

Sets the offset applied to 3D grid origin, along Z direction.

Parameters:

iOffsetValueZ: OffsetValueZ

o SetOrigin

public virtual SetOrigin( const iOrigin)

Sets 3D Grid origin.

Parameters:

iOrigin: Origin

o SetPosition

public virtual SetPosition( const iPosition)

Sets position.

Parameters:

iPosition: Position number from 1 to 8

o SetType

public virtual SetType( const iType)

Sets type.

Parameters:

iType: type enum {CATGSMGridFinite, CATGSMGridInfinite}

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