All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATTPSInterfaces Interface CATITPSBrowserUIDMUTolSettingAtt

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

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


interface CATITPSBrowserUIDMUTolSettingAtt

Interface to the DMU Tolerancing setting controller.
Role: The DMU Tolerancing setting controller object deals with the setting parameters displayed in:


Method Index


o GetClipPlaneState(unsigned char*)
Retrieves the clipping plane state attribute.
o GetDesignMode(unsigned char*)
Retrieves the Design Mode setting parameter value.
o GetDesignModeInfo(CATSettingInfo*)
Retrieves information about the Design Mode setting parameter value.
o GetPrevArea(unsigned char*)
Retrieves the Preview area when preselected annotation state attribute.
o GetPrevAreaInfo(CATSettingInfo*)
Retrieves information about the Preview Area setting parameter value.
o GetRelatedColors(long*,long*,long*)
Retrieves the Related Surface Color setting parameter value.
o GetRelatedColorsInfo(CATSettingInfo*)
Retrieves information about the Related Surface Color setting parameter value.
o GetSaveCGR(unsigned char*)
Retrieves the Save in CGR setting parameter value.
o GetSaveCGRInfo(CATSettingInfo*)
Retrieves information about the Save in CGR setting parameter value.
o GetSectPattern(unsigned char*)
Retrieves the Pattern of section when the sectionning is activate.
o GetSectPatternInfo(CATSettingInfo*)
Retrieves information about the Pattern of section when the sectionning is activate
Refer to
o SetClipPlaneState(unsigned char)
Sets the clipping plane state attribute.
o SetDesignMode(unsigned char)
Sets the Design Mode setting parameter value.
o SetDesignModeLock(unsigned char)
Locks or unlocks the Design Mode setting parameter value.
o SetPrevArea(unsigned char)
Sets the Preview area when preselected annotation state attribute.
o SetPrevAreaLock(unsigned char)
Locks or unlocks the Preview Area setting parameter value.
o SetRelatedColors(long,long,long)
Sets the Related Surface Color setting parameter value.
o SetRelatedColorsLock(unsigned char)
Locks or unlocks the Related Surface Color setting parameter value.
o SetSaveCGR(unsigned char)
Sets the Save in CGR setting parameter value.
o SetSaveCGRLock(unsigned char)
Locks or unlocks the Save in CGR setting parameter value.
o SetSectPattern(unsigned char)
Sets the Pattern of section when the sectionning is activate attribute.
o SetSectPatternLock(unsigned char)
Locks or unlocks the Pattern of section when the sectionning is activate
Refer to

Methods


o GetClipPlaneState
public virtual HRESULT GetClipPlaneState(unsigned char* oState)= 0
Retrieves the clipping plane state attribute.
o GetDesignMode
public virtual HRESULT GetDesignMode(unsigned char* ioDesignMode)= 0
Retrieves the Design Mode setting parameter value.
Role: If the Design Mode setting parameter is checked and thus set to Automatic, models are loaded in Design Mode to access technological data. Otherwise, when set to 0, models are loaded in Visualization Mode, and only visualization data is loaded.
Parameters:
ioDesignMode
[inout] A flag to indicate whether the models should be loaded in Design Mode or in Visualization Mode.
Legal values:
1 Models are loaded in Design Mode. The Automatic check button is checked
0 Models are loaded in Visualization Mode. The Automatic check button is unchecked
Returns:
S_OK if the Design Mode setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetDesignModeInfo
public virtual HRESULT GetDesignModeInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Design Mode setting parameter value.
Refer to CATSysSettingController for a detailed description.
o GetPrevArea
public virtual HRESULT GetPrevArea(unsigned char* oState)= 0
Retrieves the Preview area when preselected annotation state attribute.
o GetPrevAreaInfo
public virtual HRESULT GetPrevAreaInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Preview Area setting parameter value.
Refer to CATSysSettingController for a detailed description.
o GetRelatedColors
public virtual HRESULT GetRelatedColors(long* ioRelatedR,
long* ioRelatedG,
long* ioRelatedB)= 0
Retrieves the Related Surface Color setting parameter value.
Role: The Related Surface Color setting parameter defines the color of the annotation related surfaces, that is, of all the surfaces referenced or toleranced using the CATIA V4 FD&T function.
Legal values:The three color indexes range from 0 to 255.
Parameters:
oRelatedR
[inout] The Related Surface Color red index
oRelatedG
[inout] The Related Surface Color green index
oRelatedB
[inout] The Related Surface Color blue index
Returns:
S_OK if the Related Surface Color setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetRelatedColorsInfo
public virtual HRESULT GetRelatedColorsInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Related Surface Color setting parameter value.
Refer to CATSysSettingController for a detailed description.
o GetSaveCGR
public virtual HRESULT GetSaveCGR(unsigned char* ioSaveCGR)= 0
Retrieves the Save in CGR setting parameter value.
Parameters:
ioSaveCGR
[inout] A flag to indicate whether the models should saved in CGR format.
Legal values:
1 The models should saved in CGR format. The Save in CGR check button is checked
0 The models should not be saved in CGR format. The Save in CGR check button is unchecked
Returns:
S_OK if the Save in CGR setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetSaveCGRInfo
public virtual HRESULT GetSaveCGRInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Save in CGR setting parameter value.
Refer to CATSysSettingController for a detailed description.
o GetSectPattern
public virtual HRESULT GetSectPattern(unsigned char* oState)= 0
Retrieves the Pattern of section when the sectionning is activate.
o GetSectPatternInfo
public virtual HRESULT GetSectPatternInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Pattern of section when the sectionning is activate
Refer to CATSysSettingController for a detailed description.
o SetClipPlaneState
public virtual HRESULT SetClipPlaneState(unsigned char iState)= 0
Sets the clipping plane state attribute.
o SetDesignMode
public virtual HRESULT SetDesignMode(unsigned char iDesignMode)= 0
Sets the Design Mode setting parameter value.
Role: If the Design Mode setting parameter is checked and thus set to Automatic, models are loaded in Design Mode to access technological data. Otherwise, when set to 0, models are loaded in Visualization Mode, and only visualization data is loaded.
Parameters:
iDesignMode
[in] A flag to indicate whether the models should be loaded in Design Mode or in Visualization Mode.
Legal values:
1 Models are loaded in Design Mode. The Automatic check button is checked
0 Models are loaded in Visualization Mode. The Automatic check button is unchecked
Returns:
S_OK if the Design Mode setting parameter value is successfully set, and E_FAIL otherwise
o SetDesignModeLock
public virtual HRESULT SetDesignModeLock(unsigned char iLocked)= 0
Locks or unlocks the Design Mode setting parameter value.
Refer to CATSysSettingController for a detailed description.
o SetPrevArea
public virtual HRESULT SetPrevArea(unsigned char iState)= 0
Sets the Preview area when preselected annotation state attribute.
o SetPrevAreaLock
public virtual HRESULT SetPrevAreaLock(unsigned char iLocked)= 0
Locks or unlocks the Preview Area setting parameter value.
Refer to CATSysSettingController for a detailed description.
o SetRelatedColors
public virtual HRESULT SetRelatedColors(long iRelatedR,
long iRelatedG,
long iRelatedB)= 0
Sets the Related Surface Color setting parameter value.
Role:The Related Surface Color setting parameter defines the color of the annotation related surfaces, that is, of all the surfaces referenced or toleranced using the CATIA V4 FD&T function.
Legal values:The three color indexes range from 0 to 255.
Parameters:
iRelatedR
[in] The Related Surface Color red index
iRelatedG
[in] The Related Surface Color green index
iRelatedB
[in] The Related Surface Color blue index
Returns:
S_OK if the Related Surface Color setting parameter value is successfully set, and E_FAIL otherwise
o SetRelatedColorsLock
public virtual HRESULT SetRelatedColorsLock(unsigned char iLocked)= 0
Locks or unlocks the Related Surface Color setting parameter value.
Refer to CATSysSettingController for a detailed description.
o SetSaveCGR
public virtual HRESULT SetSaveCGR(unsigned char iSaveCGR)= 0
Sets the Save in CGR setting parameter value.
Parameters:
iSaveCGR
[in] A flag to indicate whether the models should saved in CGR format.
Legal values:
1 The models should saved in CGR format. The Save in CGR check button is checked
0 The models should not be saved in CGR format. The Save in CGR check button is unchecked
Returns:
S_OK if the Save in CGR setting parameter value is successfully set, and E_FAIL otherwise
o SetSaveCGRLock
public virtual HRESULT SetSaveCGRLock(unsigned char iLocked)= 0
Locks or unlocks the Save in CGR setting parameter value.
Refer to CATSysSettingController for a detailed description.
o SetSectPattern
public virtual HRESULT SetSectPattern(unsigned char iState)= 0
Sets the Pattern of section when the sectionning is activate attribute.
o SetSectPatternLock
public virtual HRESULT SetSectPatternLock(unsigned char iLocked)= 0
Locks or unlocks the Pattern of section when the sectionning is activate
Refer to CATSysSettingController for a detailed description.

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

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