Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFreeStyleUseItf Interface CATIStFreeStyleSettings

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

interface CATIStFreeStyleSettings

Class defining a FreeStyle Dashboard toolbar values manager.

Create an instance of CATIStFreeStyleSettings with the
global function GetFreeStyleSettings of CATIStInteractiveFactory
Only one instance will be create, further call to the
global function will read the existing instance

Method Index

o GetAttenuateFactor(CATINT32&): Return a current attenuation value:
o GetAutoDetectSnapMode(CATINT32&): Return a current autodetection mode :
o GetContinuityShowStatus(CATINT32&)
o GetControlPointShowStatus(CATINT32&): All these methodes allows to change the show/hide state of different manipulators.
o GetCouplingPointShowStatus(CATINT32&)
o GetDashboardComposition(CATUINT32&): Return the current composition of the FreeStyleDashboard : i.
o GetInNewBodyMode(CATINT32&): Return an open body creation flag :
o GetKeepMode(CATINT32&): Return a keep status :
o GetOrderShowStatus(CATINT32&)
o GetTempAnalysisMode(CATINT32&): Return a Temporary Analysis flag :
o GetTensionShowStatus(CATINT32&)
o SetAttenuateFactor(CATINT32,CATINT32)
o SetAutoDetectSnapMode(CATINT32,CATINT32): Set a current autodetection mode :
o SetContinuityShowStatus(CATINT32,CATINT32)
o SetControlPointShowStatus(CATINT32,CATINT32)
o SetCouplingPointShowStatus(CATINT32,CATINT32)
o SetDashboardComposition(CATUINT32,CATINT32): Set the current composition of the FreeStyleDashboard : i.
o SetInNewBodyMode(CATINT32,CATINT32): Set an open body creation flag :
o SetKeepMode(CATINT32,CATINT32): Set a keep status :
o SetOrderShowStatus(CATINT32,CATINT32)
o SetTempAnalysisMode(CATINT32,CATINT32): Set a Temporary Analysis flag :
o SetTensionShowStatus(CATINT32,CATINT32)

Methods

o GetAttenuateFactor

public virtual GetAttenuateFactor( oVal)

Return a current attenuation value:

Parameters:

oVal: can take one of following values : 1,2,3,4 if equal to 4 - manipulators,which subsribes to this value change will traduce the mouse movement on the screen into a very small movement 1000 times the factor exposed in FreeStyle Tools/Options when the oVal is equal to 1 of these values, the manipulator mouvement is equal to mouse mouvement on the screen

o GetAutoDetectSnapMode

public virtual GetAutoDetectSnapMode( oVal)

Return a current autodetection mode :

Parameters:

oVal: can take one of following values : SNAP_TO_VERTEX,SNAP_TO_BORDER, SNAP_TO_CTRLPT, SNAP_TO_SEGMENT (see "CATStSnappingStyle.h") when the oVal is equal to one of these values, some of selection agents in FreeStyle commands are able to snap on requered geometry and to select it.

o GetContinuityShowStatus

public virtual GetContinuityShowStatus( oVal)

o GetControlPointShowStatus

public virtual GetControlPointShowStatus( oVal)

All these methodes allows to change the show/hide state of different manipulators. If iVal or oVal are set to 0 the corresponding manipulator must be hide. If iVal or oVal are set to 1 manipulators should be shown

Parameters:

iEvt: Indicates, if the change Display Mode event should be send or not, i.e. iEvt = 1 -send event, iEvt = 0 -do not send event

o GetCouplingPointShowStatus

public virtual GetCouplingPointShowStatus( oVal)

o GetDashboardComposition

public virtual GetDashboardComposition( oMode)

Return the current composition of the FreeStyleDashboard : i.e. all buttons that are active ( visible and not greyed)

Parameters:

oMode: Concatenated value of all styles used for current Dashboard state

o GetInNewBodyMode

public virtual GetInNewBodyMode( oVal)

Return an open body creation flag :

Parameters:

oVal: 0 - the object in work will be created in current Open Body 1 - the object in work will be created in new Open Body by the current command

o GetKeepMode

public virtual GetKeepMode( oVal)

Return a keep status :

Parameters:

oVal: 0 - the object in work will be modified by the current command 1 - the object in work will be copied and only the copy will be modified by the current command

o GetOrderShowStatus

public virtual GetOrderShowStatus( oVal)

o GetTempAnalysisMode

public virtual GetTempAnalysisMode( oVal)

Return a Temporary Analysis flag :

Parameters:

oVal: 0 - any FreeStyle analysis will be created in standard feature mode 1 - called in creation/modification command any FreeStyle analysis will be created in temporary mode, i.e. will exists as long as the current command and will be removed at its end

o GetTensionShowStatus

public virtual GetTensionShowStatus( oVal)

o SetAttenuateFactor

public virtual SetAttenuateFactor(		`iVal`,
		`iEvt`	`= 0`)

Parameters:

iVal: 1 - no attenuation applied to the manipulator movement compared to mouse movement 4 - maximum attenuation applied to manipulator movement compared to mouse movement
iEvt: Indicates, if the Attenuation value change event should be send or not, i.e. iEvt = 1 -send event, iEvt = 0 -do not send event

o SetAutoDetectSnapMode

public virtual SetAutoDetectSnapMode(		`iVal`,
		`iEvt`	`= 0`)

Set a current autodetection mode :

Parameters:

iVal: Could be set to one of "CATStSnappingStyle.h" values
iEvt: Indicates, if the Autodetection Mode change event should be send or not, i.e. iEvt = 1 -send event, iEvt = 0 -do not send event

o SetContinuityShowStatus

public virtual SetContinuityShowStatus(		`iVal`,
		`iEvt`	`= 0`)

o SetControlPointShowStatus

public virtual SetControlPointShowStatus(		`iVal`,
		`iEvt`	`= 0`)

o SetCouplingPointShowStatus

public virtual SetCouplingPointShowStatus(		`iVal`,
		`iEvt`	`= 0`)

o SetDashboardComposition

public virtual SetDashboardComposition(		`iMode`,
		`iEvt`)

Set the current composition of the FreeStyleDashboard : i.e. all buttons that should be active ( visible and not greyed) during the current command, ex : Initalisation : int MyStyle = 0; Set option for the dash board style : MyStyle |= FSTensionDisplay | FSKeep Unset the Keep option in the dash board style : MyStyle = mystyle & ~FSKeep; Check one specified option from the dash board style if (MyStyle & FSKeep) see the possible style definition in "CATStDashboardStyle.h"

Parameters:

iMode: The value of concatenation of selected styles
iEvt: Indicates if the change style event should be send or not, i.e. iEvt = 1 -send event, iEvt = 0 -do not send event

o SetInNewBodyMode

public virtual SetInNewBodyMode(		`iVal`,
		`iEvt`	`= 0`)

Set an open body creation flag :

Parameters:

iVal: 0 - the object in work will be created in current Open Body 1 - the object in work will be created in new Open Body by the current command
iEvt: Indicates, if the change New Body event should be send or not, i.e. iEvt = 1 -send event, iEvt = 0 -do not send event

o SetKeepMode

public virtual SetKeepMode(		`iVal`,
		`iEvt`	`= 0`)

Set a keep status :

Parameters:

iVal: set to 0 - the object in work will be modified by the current command set to 1 - the object in work will be copied and only the copy will be modified by the current command
iEvt: Indicates if the change Keep Mode event should be send or not, i.e. iEvt = 1 -send event, iEvt = 0 -do not send event

o SetOrderShowStatus

public virtual SetOrderShowStatus(		`iVal`,
		`iEvt`	`= 0`)

o SetTempAnalysisMode

public virtual SetTempAnalysisMode(		`iVal`,
		`iEvt`	`= 0`)

Set a Temporary Analysis flag :

Parameters:

oVal: 0 - any FreeStyle analysis will be created in standard feature mode 1 - called in creation/modification command any FreeStyle analysis will be created in temporary mode, i.e. will exists as long as the current command and will be removed at its end
iEvt: Indicates, if the change Temoprary Mode event should be send or not, i.e. iEvt = 1 -send event, iEvt = 0 -do not send event

o SetTensionShowStatus

public virtual SetTensionShowStatus(		`iVal`,
		`iEvt`	`= 0`)

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