All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATIAV4Interfaces Interface CATIV4IV4V5SpaceSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIV4IV4V5SpaceSettingAtt
 

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


interface CATIV4IV4V5SpaceSettingAtt

Interface representing the V4/V5 SPACE setting controller object.
Role: The V4/V5 SPACE setting controller object deals with the setting parameters displayed in the V4/V5 SPACE property page. To access this property page:


The different options for V4/V5 SPACE tab:


Method Index


o GetDetailsModeExplode(int&)
Retrieves the DetailsModeExplode setting parameter value.
o GetDetailsModeExplodeInfo(CATSettingInfo*)
Retrieves information about the "DetailsModeExplode" setting parameter.
o GetDetailsModeUsual(int&)
Retrieves the DetailsModeUsual setting parameter value.
o GetDetailsModeUsualInfo(CATSettingInfo*)
Retrieves information about the "DetailsModeUsual" setting parameter.
o GetDetailsModeWireframe(int&)
Retrieves the DetailsModeWireframe setting parameter value.
o GetDetailsModeWireframeInfo(CATSettingInfo*)
Retrieves information about the "DetailsModeWireframe" setting parameter.
o GetExternalMaxDeformation(float&)
Retrieves the ExternalMaxDeformation setting parameter value.
o GetExternalMaxDeformationInfo(CATSettingInfo*)
Retrieves information about the "ExternalMaxDeformation" setting parameter.
o GetExternalTypeDeformation(int&)
Retrieves the ExternalTypeDeformation setting parameter value.
o GetExternalTypeDeformationInfo(CATSettingInfo*)
Retrieves information about the "ExternalTypeDeformation" setting parameter.
o GetInternalMaxDeformation(float&)
Retrieves the InternalMaxDeformation setting parameter value.
o GetInternalMaxDeformationInfo(CATSettingInfo*)
Retrieves information about the "InternalMaxDeformation" setting parameter.
o GetInternalTypeDeformation(int&)
Retrieves the InternalTypeDeformation setting parameter value (Curve Improvement).
o GetInternalTypeDeformationInfo(CATSettingInfo*)
Retrieves information about the "InternalTypeDeformation" setting parameter.
o GetKeepSegmentation(int&)
Retrieves the Keep Segmentation setting parameter value.
o GetKeepSegmentationInfo(CATSettingInfo*)
Retrieves information about the "KeepSegmentation" setting parameter.
o GetSolidMU(CATString&)
Retrieves the SolidMU setting parameter value.
o GetSolidMUInfo(CATSettingInfo*)
Retrieves information about the "SolidMU" setting parameter.
o GetTextMigration(int&)
Retrieves the TextMigration setting parameter value.
o GetTextMigrationInfo(CATSettingInfo*)
Retrieves information about the "TextMigration" setting parameter.
o SetDetailsModeExplode(int)
Sets the DetailsModeExplode setting parameter value.
o SetDetailsModeExplodeLock(unsigned char)
Locks or unlocks the "DetailsModeExplode" setting parameter.
o SetDetailsModeUsual(int)
Sets the DetailsModeUsual setting parameter value.
o SetDetailsModeUsualLock(unsigned char)
Locks or unlocks the "DetailsModeUsual" setting parameter.
o SetDetailsModeWireframe(int)
Sets the DetailsModeWireframe setting parameter value.
o SetDetailsModeWireframeLock(unsigned char)
Locks or unlocks the "DetailsModeWireframe" setting parameter.
o SetExternalMaxDeformation(float)
Sets the state of the "ExternalMaxDeformation" setting parameter (Gap Healing).
o SetExternalMaxDeformationLock(unsigned char)
Locks or unlocks the "ExternalMaxDeformation" setting parameter.
o SetExternalTypeDeformation(int)
Sets the state of the "ExternalTypeDeformation" setting parameter (Gap Healing).
o SetExternalTypeDeformationLock(unsigned char)
Locks or unlocks the "ExternalTypeDeformation" setting parameter.
o SetInternalMaxDeformation(float)
Sets the state of the "InternalMaxDeformation" setting parameter (Curve Improvement).
o SetInternalMaxDeformationLock(unsigned char)
Locks or unlocks the "InternalMaxDeformation" setting parameter.
o SetInternalTypeDeformation(int)
Sets the state of the "InternalTypeDeformation" setting parameter (Gap Healing).
o SetInternalTypeDeformationLock(unsigned char)
Locks or unlocks the "InternalTypeDeformation" setting parameter.
o SetKeepSegmentation(int)
Sets the Keep Segmentation setting parameter value.
o SetKeepSegmentationLock(unsigned char)
Locks or unlocks the "KeepSegmentation" setting parameter.
o SetSolidMU(CATString&)
Sets the SolidMU setting parameter value.
o SetSolidMULock(unsigned char)
Locks or unlocks the "SolidMU" setting parameter.
o SetTextMigration(int)
Sets the TextMigration setting parameter value.
o SetTextMigrationLock(unsigned char)
Locks or unlocks the "TextMigration" setting parameter.

Methods


o GetDetailsModeExplode
public virtual HRESULT GetDetailsModeExplode(int& oDetailsChoiceExplode) = 0
Retrieves the DetailsModeExplode setting parameter value.
Role: The DetailsModeExplode setting parameter manages the dittos migration
Parameters:
oDetailsChoiceExplode
The DetailsModeExplode setting parameter value. Disabled by default, the DetailsModeExplode option allows to explode dittos when migration to V5 elements
Returns:
S_OK if the DetailsModeExplode setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetDetailsModeExplodeInfo
public virtual HRESULT GetDetailsModeExplodeInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "DetailsModeExplode" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetDetailsModeUsual
public virtual HRESULT GetDetailsModeUsual(int& oDetailsChoiceUsual) = 0
Retrieves the DetailsModeUsual setting parameter value.
Role: The DetailsModeUsual setting parameter manages the dittos migration
Parameters:
oDetailsChoiceUsual
The DetailsModeUsual setting parameter value. Activated by default, the DetailsModeUsual option allows to migrate dittos to V5 elements with optimized usual mode
Returns:
S_OK if the DetailsModeUsual setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetDetailsModeUsualInfo
public virtual HRESULT GetDetailsModeUsualInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "DetailsModeUsual" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetDetailsModeWireframe
public virtual HRESULT GetDetailsModeWireframe(int& oDetailsChoiceWireframe) = 0
Retrieves the DetailsModeWireframe setting parameter value.
Role: The DetailsModeWireframe setting parameter manages the dittos migration
Parameters:
oDetailsChoiceWireframe
The DetailsModeWireframe setting parameter value. Disabled by default, the DetailsModeWireframe option allows to migrate the isolated wireframe elements for each ditto to V5 elements too
Returns:
S_OK if the DetailsModeWireframe setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetDetailsModeWireframeInfo
public virtual HRESULT GetDetailsModeWireframeInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "DetailsModeWireframe" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExternalMaxDeformation
public virtual HRESULT GetExternalMaxDeformation(float& oExtMaxDef) = 0
Retrieves the ExternalMaxDeformation setting parameter value.
Role: The External Maximum Deformation setting parameter manages the maximum authorized for external deformation
Parameters:
oExtMaxDef
The External Maximum Deformation setting parameter value Legal values: A float typed by the user
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetExternalMaxDeformationInfo
public virtual HRESULT GetExternalMaxDeformationInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "ExternalMaxDeformation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExternalTypeDeformation
public virtual HRESULT GetExternalTypeDeformation(int& oExtDefType) = 0
Retrieves the ExternalTypeDeformation setting parameter value.
Role: The External Type Deformation setting parameter manages the deformation type
Parameters:
oExtDefType
The External Deformation Type Legal values:
0: "Model Relative"
1: "User defined value"
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetExternalTypeDeformationInfo
public virtual HRESULT GetExternalTypeDeformationInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "ExternalTypeDeformation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetInternalMaxDeformation
public virtual HRESULT GetInternalMaxDeformation(float& oIntMaxDef) = 0
Retrieves the InternalMaxDeformation setting parameter value.
Role: The Internal Maximum Deformation setting parameter manages the maximum authorized for internal deformation
Parameters:
oIntMaxDef
The Internal Maximum Deformation stting parameter value
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInternalMaxDeformationInfo
public virtual HRESULT GetInternalMaxDeformationInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "InternalMaxDeformation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetInternalTypeDeformation
public virtual HRESULT GetInternalTypeDeformation(int& oIntDefType) = 0
Retrieves the InternalTypeDeformation setting parameter value (Curve Improvement).
Role: The Internal Type Deformation setting parameter manages the deformation type
Parameters:
oIntDefType
The Internal Deformation Type Legal values:
0: "Model Relative"
1: "User defined value"
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInternalTypeDeformationInfo
public virtual HRESULT GetInternalTypeDeformationInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "InternalTypeDeformation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetKeepSegmentation
public virtual HRESULT GetKeepSegmentation(int& oSegmentationState) = 0
Retrieves the Keep Segmentation setting parameter value.
Role: The KeepSegmentation setting parameter manages the segmentation
Parameters:
oSegmentationState
The KeepSegmentation setting parameter value. Disabled by default, the KeepSegmentation option allows to keep V4 Segmentation
Returns:
S_OK if the KeepSegmentation setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetKeepSegmentationInfo
public virtual HRESULT GetKeepSegmentationInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "KeepSegmentation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetSolidMU
public virtual HRESULT GetSolidMU(CATString& ochoiceMU) = 0
Retrieves the SolidMU setting parameter value.
Role: The SolidMU setting parameter manages the migration for Solids Mock-Up
Parameters:
ochoiceMU
The SolidMU setting parameter value. The SolidMU option allows to convert isolated Solid Mock-up as CGR or as PartBody. By default, the "as CGR" option is enabled.
Returns:
S_OK if the SolidMU setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetSolidMUInfo
public virtual HRESULT GetSolidMUInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "SolidMU" setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetTextMigration
public virtual HRESULT GetTextMigration(int& oTextMigrationState) = 0
Retrieves the TextMigration setting parameter value.
Role: The TextMigration setting parameter manages the 3D text migration
Parameters:
oTextMigrationState
The TextMigration setting parameter value. Disabled by default, the TextMigration option allows to migrate 3D texts during copy/paste
Returns:
S_OK if the TextMigration setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetTextMigrationInfo
public virtual HRESULT GetTextMigrationInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the "TextMigration" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetDetailsModeExplode
public virtual HRESULT SetDetailsModeExplode(int iDetailsChoiceExplode)= 0
Sets the DetailsModeExplode setting parameter value.
Role: The DetailsModeExplode setting parameter manages the dittos migration
Parameters:
iDetailsChoiceExplode
The DetailsModeExplode setting parameter value. Disabled by default, the DetailsModeExplode option allows to explode dittos when migration to V5 elements
Returns:
S_OK if the DetailsModeExplode setting parameter value is successfully retrieved, and E_FAIL otherwise
o SetDetailsModeExplodeLock
public virtual HRESULT SetDetailsModeExplodeLock(unsigned char iLocked)= 0
Locks or unlocks the "DetailsModeExplode" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetDetailsModeUsual
public virtual HRESULT SetDetailsModeUsual(int iDetailsChoiceUsual)= 0
Sets the DetailsModeUsual setting parameter value.
Role: The DetailsModeUsual setting parameter manages the dittos migration
Parameters:
iDetailsChoiceUsual
The DetailsModeUsual setting parameter value. Activated by default, the DetailsModeUsual option allows to migrate dittos to V5 elements with optimized usual mode
Returns:
S_OK if the DetailsModeUsual setting parameter value is successfully retrieved, and E_FAIL otherwise
o SetDetailsModeUsualLock
public virtual HRESULT SetDetailsModeUsualLock(unsigned char iLocked)= 0
Locks or unlocks the "DetailsModeUsual" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetDetailsModeWireframe
public virtual HRESULT SetDetailsModeWireframe(int iDetailsChoiceWireframe)= 0
Sets the DetailsModeWireframe setting parameter value.
Role: The DetailsModeWireframe setting parameter manages the dittos migration
Parameters:
iDetailsChoiceWireframe
The DetailsModeWireframe setting parameter value. Disabled by default, the DetailsModeWireframe option allows to migrate the isolated wireframe elements for each ditto to V5 elements too
Returns:
S_OK if the DetailsModeWireframe setting parameter value is successfully retrieved, and E_FAIL otherwise
o SetDetailsModeWireframeLock
public virtual HRESULT SetDetailsModeWireframeLock(unsigned char iLocked)= 0
Locks or unlocks the "DetailsModeWireframe" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExternalMaxDeformation
public virtual HRESULT SetExternalMaxDeformation(float iExtMaxDef)= 0
Sets the state of the "ExternalMaxDeformation" setting parameter (Gap Healing).
Role: The External Maximum Deformation setting parameter manages the deformation type
Parameters:
iExtMaxDef
The External Maximum Deformation setting parameter value
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetExternalMaxDeformationLock
public virtual HRESULT SetExternalMaxDeformationLock(unsigned char iLocked)= 0
Locks or unlocks the "ExternalMaxDeformation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExternalTypeDeformation
public virtual HRESULT SetExternalTypeDeformation(int iExtDefType)= 0
Sets the state of the "ExternalTypeDeformation" setting parameter (Gap Healing).
Role: The External Type Deformation setting parameter manages the deformation type
Parameters:
iExtDefType
The conversion mode. Legal values:
0: "Model Relative"
1: "User defined value"
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetExternalTypeDeformationLock
public virtual HRESULT SetExternalTypeDeformationLock(unsigned char iLocked)= 0
Locks or unlocks the "ExternalTypeDeformation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetInternalMaxDeformation
public virtual HRESULT SetInternalMaxDeformation(float iIntMaxDef)= 0
Sets the state of the "InternalMaxDeformation" setting parameter (Curve Improvement).
Role: The Internal Maximum Deformation setting parameter manages the deformation type
Parameters:
iIntMaxDef
The External Maximum Deformation setting parameter value
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetInternalMaxDeformationLock
public virtual HRESULT SetInternalMaxDeformationLock(unsigned char iLocked)= 0
Locks or unlocks the "InternalMaxDeformation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetInternalTypeDeformation
public virtual HRESULT SetInternalTypeDeformation(int iIntDefType)= 0
Sets the state of the "InternalTypeDeformation" setting parameter (Gap Healing).
Role: The Internal Type Deformation setting parameter manages the deformation type
Parameters:
iIntDefType
The conversion mode. Legal values:
0: "Model Relative"
1: "User defined value"
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetInternalTypeDeformationLock
public virtual HRESULT SetInternalTypeDeformationLock(unsigned char iLocked)= 0
Locks or unlocks the "InternalTypeDeformation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetKeepSegmentation
public virtual HRESULT SetKeepSegmentation(int iSegmentationState)= 0
Sets the Keep Segmentation setting parameter value.
Parameters:
iSegmentationState
The KeepSegmentation setting parameter value. Disabled by default, the KeepSegmentation option allows to keep V4 Segmentation
Returns:
S_OK if the KeepSegmentation setting parameter value is successfully retrieved, and E_FAIL otherwise
o SetKeepSegmentationLock
public virtual HRESULT SetKeepSegmentationLock(unsigned char iLocked)= 0
Locks or unlocks the "KeepSegmentation" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetSolidMU
public virtual HRESULT SetSolidMU(CATString& ichoiceMU)= 0
Sets the SolidMU setting parameter value.
Role: The SolidMU setting parameter manages the migration for Solids Mock-Up
Parameters:
ichoiceMU
The SolidMU setting parameter value. The SolidMU option allows to convert isolated Solid Mock-up as CGR or as PartBody. By default, the "as CGR" option is enabled.
Returns:
S_OK if the SolidMU setting parameter value is successfully retrieved, and E_FAIL otherwise
o SetSolidMULock
public virtual HRESULT SetSolidMULock(unsigned char iLocked)= 0
Locks or unlocks the "SolidMU" setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetTextMigration
public virtual HRESULT SetTextMigration(int iTextMigrationState)= 0
Sets the TextMigration setting parameter value.
Role: The TextMigration setting parameter manages the dittos migration
Parameters:
iTextMigrationState
The TextMigration setting parameter value. Disabled by default, the TextMigration option allows to migrate 3D texts during copy/paste
Returns:
S_OK if the TextMigration setting parameter value is successfully retrieved, and E_FAIL otherwise
o SetTextMigrationLock
public virtual HRESULT SetTextMigrationLock(unsigned char iLocked)= 0
Locks or unlocks the "TextMigration" setting parameter.
Refer to CATSysSettingController for a detailed description.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.