All Frameworks Class Hierarchy This Framework Previous Next Indexes
FittingInterfaces Interface CATISiFiManipSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISiFiManipSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISiFiManipSettingAtt
Interface to handle parameters of DMU Manip Tools Options Tab page
Role: This interface is implemented by a component which
represents the controller of DMU Manip Tools Options parameter settings.
- Methods to set value of each parameter
- Methods to get value of each parameter
- Methods to get information on each parameter
- Methods to lock/unlock value of each parameter
Method Index
- o
GetAngleStep(float&)
- Returns the Angle Step parameter
Role: Returns the Angle Step parameter
- o
GetAngleStepInfo(CATSettingInfo*)
- Retrieves the state of the AngleStepInfo parameter.
- o
GetClashMode(CATManipClashMode&)
- Returns the ClashMode (manipulation mode) for simulation and tracks
Role: Returns the ClashMode (manipulation mode) for simulation
and tracks
- o
GetClashModeInfo(CATSettingInfo*)
- Retrieves the state of the ClashModeInfo parameter.
- o
GetClashSound(CATBoolean&)
- Returns the Clash Sound parameter
Role: Returns the Clash Sound parameter
- o
GetClashSoundInfo(CATSettingInfo*)
- Retrieves the state of the ClashSoundInfo parameter.
- o
GetDistanceStep(float&)
- Returns the Distance Step parameter
Role: Returns the Distance Step parameter
- o
GetDistanceStepInfo(CATSettingInfo*)
- Retrieves the state of the DistanceStepInfo parameter.
- o
GetManipAutoInsert(CATBoolean&)
- Returns the ManipAutoInsert parameter
Role: Returns the ManipAutoInsert (Automatic insert for manipulation
mode) parameter.
- o
GetManipAutoInsertInfo(CATSettingInfo*)
- Retrieves the state of the ManipAutoInsertInfo parameter.
- o
GetRecordMode(CATManipAutoInsertMode&)
- Returns the RecordMode for Auto Insert configuration
Role: Returns the RecordMode for Auto Insert configuration
- o
GetRecordModeInfo(CATSettingInfo*)
- Retrieves the state of the RecordModeInfo parameter.
- o
GetSnapAngleDistance(float&)
- Returns the Snap Angle Distance parameter
Role: Returns the Angle Distance parameter of the Snap Sensitivity
- o
GetSnapAngleDistanceInfo(CATSettingInfo*)
- Retrieves the state of the SnapAngleDistanceInfo parameter.
- o
GetSnapPosition(float&)
- Returns the Snap Position parameter
Role: Returns the Position parameter of the Snap Sensitivity
- o
GetSnapPositionInfo(CATSettingInfo*)
- Retrieves the state of the SnapPositionInfo parameter.
- o
SetAngleStep(float)
- Sets the Angle Step parameter
Role: Sets the Angle Step parameter
- o
SetAngleStepLock(unsigned char)
- Locks or unlocks the AngleStep parameter.
- o
SetClashMode(CATManipClashMode)
- Sets the ClashMode (manipulation mode) for simulation and tracks
Role: Sets the ClashMode (manipulation mode) for simulation
and tracks
- o
SetClashModeLock(unsigned char)
- Locks or unlocks the ClashMode parameter.
- o
SetClashSound(CATBoolean)
- Sets the Clash Sound parameter
Role: Sets the Clash Sound parameter
- o
SetClashSoundLock(unsigned char)
- Locks or unlocks the ClashSound parameter.
- o
SetDistanceStep(float)
- Sets the Distance Step parameter
Role: Returns the Distance Step parameter
- o
SetDistanceStepLock(unsigned char)
- Locks or unlocks the DistanceStep parameter.
- o
SetManipAutoInsert(CATBoolean)
- Sets the ManipAutoInsert parameter
Role: Sets the ManipAutoInsert (Automatic insert for manipulation
mode) parameter.
- o
SetManipAutoInsertLock(unsigned char)
- Locks or unlocks the ManipAutoInsert parameter.
- o
SetRecordMode(CATManipAutoInsertMode)
- Sets the RecordMode for Auto Insert configuration
Role: Sets the RecordMode if angle limitation is being used
- o
SetRecordModeLock(unsigned char)
- Locks or unlocks the RecordMode parameter.
- o
SetSnapAngleDistance(float)
- Sets the Snap Angle Distance parameter
Role: Sets the Angle Distance parameter of the Snap Sensitivity
- o
SetSnapAngleDistanceLock(unsigned char)
- Locks or unlocks the SnapAngleDistance parameter.
- o
SetSnapPosition(float)
- Sets the Snap Position parameter
Role: Sets the Position parameter of the Snap Sensitivity
- o
SetSnapPositionLock(unsigned char)
- Locks or unlocks the SnapPosition parameter.
Methods
o GetAngleStep
public virtual HRESULT GetAngleStep( | float& | oAngleStep)= 0 |
-
Returns the Angle Step parameter
Role: Returns the Angle Step parameter
- Parameters:
-
- oDefaultSpeed
-
Will be set to the current value of the Angle Step
- Returns:
- S_OK : if the Angle Step value was correctly obtained
E_FAIL : if the Angle Step value was not correctly obtained
o GetAngleStepInfo
-
Retrieves the state of the AngleStepInfo parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClashMode
-
Returns the ClashMode (manipulation mode) for simulation and tracks
Role: Returns the ClashMode (manipulation mode) for simulation
and tracks
- Parameters:
-
- oMode
- The ClashMode (manipulation mode) for simulation and tracks
Legal values:
CATManipClashModeNo Clash Detection is set to OFF
CATManipClashModeOn Clash Detection is set to ON
CATManipClashModeStop Clash Detection is set to STOP
- Returns:
- S_OK : if the ClashMode value was correctly obtained
E_FAIL : if the ClashMode value was not correctly obtained
o GetClashModeInfo
-
Retrieves the state of the ClashModeInfo parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClashSound
-
Returns the Clash Sound parameter
Role: Returns the Clash Sound parameter
- Parameters:
-
- oClashSound
- If Clash Beep feedback is to be used.
Legal values:
TRUE Clash Beep feedback is enabled
FALSE Clash Beep feedback is disabled
- Returns:
- S_OK : if the Clash Sound value was correctly obtained
E_FAIL : if the Clash Sound value was not correctly obtained
o GetClashSoundInfo
-
Retrieves the state of the ClashSoundInfo parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDistanceStep
public virtual HRESULT GetDistanceStep( | float& | oDistanceStep)= 0 |
-
Returns the Distance Step parameter
Role: Returns the Distance Step parameter
- Parameters:
-
- oDefaultSpeed
-
Will be set to the current value of the Distance Step
- Returns:
- S_OK : if the Distance Step value was correctly obtained
E_FAIL : if the Distance Step value was not correctly obtained
o GetDistanceStepInfo
-
Retrieves the state of the DistanceStepInfo parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetManipAutoInsert
-
Returns the ManipAutoInsert parameter
Role: Returns the ManipAutoInsert (Automatic insert for manipulation
mode) parameter.
- Parameters:
-
- oManipAutoInsert
- If Automatic insert for manipulation mode is to be used.
Legal values:
TRUE Automatic insert for manipulation mode is enabled
FALSE Automatic insert for manipulation mode is disabled
- Returns:
- S_OK : if the ManipAutoInsert value was correctly obtained
E_FAIL : if the ManipAutoInsert value was not correctly obtained
o GetManipAutoInsertInfo
-
Retrieves the state of the ManipAutoInsertInfo parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRecordMode
-
Returns the RecordMode for Auto Insert configuration
Role: Returns the RecordMode for Auto Insert configuration
- Parameters:
-
- oMode
- The Record Mode that will be used for auto insert
Legal values:
CATOnMouseRelease On each mouse release
CATWhileMouseMoving On specific parameters
- Returns:
- S_OK : if the RecordMode value was correctly obtained
E_FAIL : if the RecordMode value was not correctly obtained
o GetRecordModeInfo
-
Retrieves the state of the RecordModeInfo parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSnapAngleDistance
public virtual HRESULT GetSnapAngleDistance( | float& | oSnapAngleDistance)= 0 |
-
Returns the Snap Angle Distance parameter
Role: Returns the Angle Distance parameter of the Snap Sensitivity
- Parameters:
-
- oSnapPosition
-
Will be set to the current value of the Angle Distance parameter of the
Snap Sensitivity
- Returns:
- S_OK : if the Snap Angle Distance value was correctly obtained
E_FAIL : if the Snap Angle Distance value was not correctly obtained
o GetSnapAngleDistanceInfo
-
Retrieves the state of the SnapAngleDistanceInfo parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSnapPosition
public virtual HRESULT GetSnapPosition( | float& | oSnapPosition)= 0 |
-
Returns the Snap Position parameter
Role: Returns the Position parameter of the Snap Sensitivity
- Parameters:
-
- oSnapPosition
-
Will be set to the current value of the Position parameter of the
Snap Sensitivity
- Returns:
- S_OK : if the Snap Position value was correctly obtained
E_FAIL : if the Snap Position value was not correctly obtained
o GetSnapPositionInfo
-
Retrieves the state of the SnapPositionInfo parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAngleStep
public virtual HRESULT SetAngleStep( | const float | iAngleStep)= 0 |
-
Sets the Angle Step parameter
Role: Sets the Angle Step parameter
- Parameters:
-
- iDefaultSpeed
-
Used to set the Angle Step parameter
- Returns:
- S_OK : if the Angle Step value was correctly obtained
E_FAIL : if the Angle Step value was not correctly obtained
o SetAngleStepLock
public virtual HRESULT SetAngleStepLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AngleStep parameter.
Role:Locks or unlocks the AngleStep parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClashMode
-
Sets the ClashMode (manipulation mode) for simulation and tracks
Role: Sets the ClashMode (manipulation mode) for simulation
and tracks
- Parameters:
-
- iMode
- The ClashMode (manipulation mode) for simulation and tracks
Legal values:
CATManipClashModeNo Clash Detection is set to OFF
CATManipClashModeOn Clash Detection is set to ON
CATManipClashModeStop Clash Detection is set to STOP
- Returns:
- S_OK : if the ClashMode value was set correctly
E_FAIL : if the ClashMode value was not set correctly
o SetClashModeLock
public virtual HRESULT SetClashModeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ClashMode parameter.
Role:Locks or unlocks the ClashMode parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClashSound
-
Sets the Clash Sound parameter
Role: Sets the Clash Sound parameter
- Parameters:
-
- iClashSound
- If Clash Beep feedback is to be used.
Legal values:
TRUE : to enable Clash Beep feedback
FALSE: to disable Clash Beep feedback
- Returns:
- S_OK : if the Clash Sound value was set correctly
E_FAIL : if the Clash Sound value was not set correctly
o SetClashSoundLock
public virtual HRESULT SetClashSoundLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ClashSound parameter.
Role:Locks or unlocks the ClashSound parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDistanceStep
public virtual HRESULT SetDistanceStep( | const float | iDistanceStep)= 0 |
-
Sets the Distance Step parameter
Role: Returns the Distance Step parameter
- Parameters:
-
- iDefaultSpeed
-
Used to set the Distance Step parameter
- Returns:
- S_OK : if the Distance Step value was correctly obtained
E_FAIL : if the Distance Step value was not correctly obtained
o SetDistanceStepLock
public virtual HRESULT SetDistanceStepLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the DistanceStep parameter.
Role:Locks or unlocks the DistanceStep parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetManipAutoInsert
-
Sets the ManipAutoInsert parameter
Role: Sets the ManipAutoInsert (Automatic insert for manipulation
mode) parameter.
- Parameters:
-
- iManipAutoInsert
- If Automatic insert for manipulation mode is to be used.
Legal values:
TRUE : to enable Automatic insert for manipulation mode
FALSE: to disable Automatic insert for manipulation mode
- Returns:
- S_OK : if the ManipAutoInsert value was set correctly
E_FAIL : if the ManipAutoInsert value was not set correctly
o SetManipAutoInsertLock
public virtual HRESULT SetManipAutoInsertLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ManipAutoInsert parameter.
Role:Locks or unlocks the ManipAutoInsert parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRecordMode
-
Sets the RecordMode for Auto Insert configuration
Role: Sets the RecordMode if angle limitation is being used
- Parameters:
-
- iMode
- The Record Mode that will be used for auto insert
Legal values:
CATOnMouseRelease On each mouse release
CATWhileMouseMoving On specific parameters
- Returns:
- S_OK : if the RecordMode value was set correctly
E_FAIL : if the RecordMode value was not set correctly
o SetRecordModeLock
public virtual HRESULT SetRecordModeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the RecordMode parameter.
Role:Locks or unlocks the RecordMode parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSnapAngleDistance
public virtual HRESULT SetSnapAngleDistance( | const float | iSnapAngleDistance)= 0 |
-
Sets the Snap Angle Distance parameter
Role: Sets the Angle Distance parameter of the Snap Sensitivity
- Parameters:
-
- iSnapPosition
-
Used to set the Angle Distance parameter of the Snap Sensitivity
- Returns:
- S_OK : if the Snap Angle Distance value was correctly obtained
E_FAIL : if the Snap Angle Distance value was not correctly obtained
o SetSnapAngleDistanceLock
public virtual HRESULT SetSnapAngleDistanceLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the SnapAngleDistance parameter.
Role:Locks or unlocks the SnapAngleDistance parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSnapPosition
public virtual HRESULT SetSnapPosition( | const float | iSnapPosition)= 0 |
-
Sets the Snap Position parameter
Role: Sets the Position parameter of the Snap Sensitivity
- Parameters:
-
- iSnapPosition
-
Used to set the Snap Position parameter of the Snap Sensitivity
- Returns:
- S_OK : if the Snap Position value was correctly obtained
E_FAIL : if the Snap Position value was not correctly obtained
o SetSnapPositionLock
public virtual HRESULT SetSnapPositionLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the SnapPosition parameter.
Role:Locks or unlocks the SnapPosition parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
This object is included in the file: CATISiFiManipSettingAtt.h
If needed, your Imakefile.mk should include the module: CATFittingInterfaces