All Frameworks Class Hierarchy This Framework Previous Next Indexes
Visualization Interface CATIVisVrmlSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIVisVrmlSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVisVrmlSettingAtt
The interface to access a CATIVisVrmlSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option\General\Compatibility.... the settings values
of the VRML sheet.
Method Index
- o
GetExportBackgroundColor(unsigned int*,unsigned int*,unsigned int*)
- Returns the ExportBackgroundColor parameter (Background color of exported Vrml files).
- o
GetExportBackgroundColorInfo(CATSettingInfo*)
- Retrieves information about the ExportBackgroundColor setting parameter.
- o
GetExportEdges(CATBoolean&)
- Returns the ExportEdges parameter (exported Vrml files will or will not contains edge informations).
- o
GetExportEdgesInfo(CATSettingInfo*)
- Retrieves information about the ExportEdges setting parameter.
- o
GetExportNormals(CATBoolean&)
- Returns the ExportNormals parameter (exported Vrml files will or will not contains normal informations).
- o
GetExportNormalsInfo(CATSettingInfo*)
- Retrieves information about the ExportNormals setting parameter.
- o
GetExportTexture(CATBoolean&)
- Returns the ExportTexture parameter (exported Vrml files will or will not contains texture informations).
- o
GetExportTextureFile(unsigned int&)
- Returns the ExportTextureFile parameter (Textures will be exported in the vrml file containing the geometry
or in external files).
- o
GetExportTextureFileInfo(CATSettingInfo*)
- Retrieves information about the ExportTextureFile setting parameter.
- o
GetExportTextureFormat(unsigned int&)
- DO NOT USE.
- o
GetExportTextureFormatInfo(CATSettingInfo*)
- Retrieves information about the ExportTextureFile setting parameter.
- o
GetExportTextureInfo(CATSettingInfo*)
- Retrieves information about the ExportTexture setting parameter.
- o
GetExportVersion(unsigned int&)
- Returns the ExportVersion parameter (version of exported Vrml files).
- o
GetExportVersionInfo(CATSettingInfo*)
- Retrieves information about the ExportVersion setting parameter.
- o
GetImportCreaseAngle(float&)
- Returns the ImportCreaseAngle parameter.
- o
GetImportCreaseAngleInfo(CATSettingInfo*)
- Retrieves information about the ImportCreaseAngle setting parameter.
- o
GetImportUnit(unsigned int&)
- Returns the ImportUnit parameter (unit of imported Vrml files).
- o
GetImportUnitInfo(CATSettingInfo*)
- Retrieves information about the ImportUnit setting parameter.
- o
SetExportBackgroundColor(unsigned int,unsigned int,unsigned int)
- Sets the ExportBackgroundColor parameter (Background color of exported Vrml files).
- o
SetExportBackgroundColorLock(unsigned char)
- Locks or unlocks the ExportBackgroundColor setting parameter.
- o
SetExportEdges(CATBoolean)
- Sets the ExportEdges parameter (exported Vrml files will or will not contains edge informations).
- o
SetExportEdgesLock(unsigned char)
- Locks or unlocks the ExportEdgesLock setting parameter.
- o
SetExportNormals(CATBoolean)
- Sets the ExportNormals parameter (exported Vrml files will or will not contains normal informations).
- o
SetExportNormalsLock(unsigned char)
- Locks or unlocks the ExportNormalsLock setting parameter.
- o
SetExportTexture(CATBoolean)
- Sets the ExportTexture parameter (exported Vrml files will or will not contains texture informations).
- o
SetExportTextureFile(unsigned int)
- Sets the ExportTextureFile parameter (Textures will be exported in the vrml file containing the geometry
or in external files).
- o
SetExportTextureFileLock(unsigned char)
- Locks or unlocks the ExportTextureFile setting parameter.
- o
SetExportTextureFormat(unsigned int)
- DO NOT USE.
- o
SetExportTextureFormatLock(unsigned char)
- Locks or unlocks the ExportTextureFile setting parameter.
- o
SetExportTextureLock(unsigned char)
- Locks or unlocks the ExportTextureLock setting parameter.
- o
SetExportVersion(unsigned int)
- Sets the ExportVersion parameter (version of exported Vrml files).
- o
SetExportVersionLock(unsigned char)
- Locks or unlocks the ExportVersionLock setting parameter.
- o
SetImportCreaseAngle(float)
- Sets the ImportCreaseAngle parameter.
- o
SetImportCreaseAngleLock(unsigned char)
- Locks or unlocks the ImportCreaseAngle setting parameter.
- o
SetImportUnit(unsigned int)
- Sets the ImportUnit parameter (unit of imported Vrml files).
- o
SetImportUnitLock(unsigned char)
- Locks or unlocks the ImportUnit setting parameter.
Methods
o GetExportBackgroundColor
public virtual HRESULT GetExportBackgroundColor( | unsigned int* | ioR, |
| unsigned int* | ioG, |
| unsigned int* | ioB)= 0 |
-
Returns the ExportBackgroundColor parameter (Background color of exported Vrml files).
- Parameters:
-
- oExportBackgroundColor
- Value of ExportBackgroundColor parameter.
Legal values:
R [0,255] G [0,255] B [0,255]
o GetExportBackgroundColorInfo
-
Retrieves information about the ExportBackgroundColor setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetExportEdges
-
Returns the ExportEdges parameter (exported Vrml files will or will not contains edge informations).
- Parameters:
-
- oExportEdges
- Value of ExportEdges parameter.
Legal values:
TRUE : exported Vrml files will contain edge informations.
FALSE : exported Vrml files will not contain edge informations.
o GetExportEdgesInfo
-
Retrieves information about the ExportEdges setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetExportNormals
-
Returns the ExportNormals parameter (exported Vrml files will or will not contains normal informations).
- Parameters:
-
- oExportNormals
- Value of ExportNormals parameter.
Legal values:
TRUE : exported Vrml files will contain normal informations.
FALSE : exported Vrml files will not contain normal informations.
o GetExportNormalsInfo
-
Retrieves information about the ExportNormals setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetExportTexture
-
Returns the ExportTexture parameter (exported Vrml files will or will not contains texture informations).
- Parameters:
-
- oExportTexture
- Value of ExportTexture parameter.
Legal values:
TRUE : exported Vrml files will contain texture informations.
FALSE : exported Vrml files will not contain texture informations.
o GetExportTextureFile
public virtual HRESULT GetExportTextureFile( | unsigned int& | oExportTextureFile)= 0 |
-
Returns the ExportTextureFile parameter (Textures will be exported in the vrml file containing the geometry
or in external files).
- Parameters:
-
- oExportTextureFile
- Value of ExportTextureFile parameter.
Legal values:
0 : Textures are exported in the Vrml file containing the geometry.
1 : Texture are exported in external files.
o GetExportTextureFileInfo
-
Retrieves information about the ExportTextureFile setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetExportTextureFormat
public virtual HRESULT GetExportTextureFormat( | unsigned int& | oExportTextureFormat)= 0 |
-
DO NOT USE.
Returns the ExportTextureFormat parameter.
- Parameters:
-
- oExportTextureFormat
- Value of ExportTextureFormat parameter.
Legal values:
NOT APPLICABLE
o GetExportTextureFormatInfo
-
Retrieves information about the ExportTextureFile setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetExportTextureInfo
-
Retrieves information about the ExportTexture setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetExportVersion
public virtual HRESULT GetExportVersion( | unsigned int& | oExportVersion)= 0 |
-
Returns the ExportVersion parameter (version of exported Vrml files).
- Parameters:
-
- oExportVersion
- Value of Import Unit parameter.
Legal values:
1 : VRML 1.0.
2 : VRML 97 (VRML 2.0).
o GetExportVersionInfo
-
Retrieves information about the ExportVersion setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetImportCreaseAngle
public virtual HRESULT GetImportCreaseAngle( | float& | oImportCreaseAngle)= 0 |
-
Returns the ImportCreaseAngle parameter.
The crease angle affects how DEFAULT normals are generated. If the angle between the geometric normals of two
adjacent faces is less than the crease angle, normals will be calculated so that the faces are smooth-shaded
across the edge. Otherwise, normals will be calculated so that a lighting discontinuity across the edge is
produced.
- Parameters:
-
- oImportCreaseAngle
- Value of ImportCreaseAngle parameter.
Legal values:
[0,inf]
o GetImportCreaseAngleInfo
-
Retrieves information about the ImportCreaseAngle setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetImportUnit
public virtual HRESULT GetImportUnit( | unsigned int& | oImportUnit)= 0 |
-
Returns the ImportUnit parameter (unit of imported Vrml files).
- Parameters:
-
- oImportUnit
- Value of Import Unit parameter.
Legal values:
0 : Millimeter.
1 : Centimeter.
2 : Meter.
o GetImportUnitInfo
-
Retrieves information about the ImportUnit setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetExportBackgroundColor
public virtual HRESULT SetExportBackgroundColor( | const unsigned int | iR, |
| const unsigned int | iG, |
| const unsigned int | iB)= 0 |
-
Sets the ExportBackgroundColor parameter (Background color of exported Vrml files).
- Parameters:
-
- iExportBackgroundColor
- Value of ExportBackgroundColor parameter.
Legal values:
R [0,255] G [0,255] B [0,255]
o SetExportBackgroundColorLock
public virtual HRESULT SetExportBackgroundColorLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ExportBackgroundColor setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetExportEdges
-
Sets the ExportEdges parameter (exported Vrml files will or will not contains edge informations).
- Parameters:
-
- iExportEdges
- Value of ExportEdges parameter.
Legal values:
TRUE : exported Vrml files will contain edge informations.
FALSE : exported Vrml files will not contain edge informations.
o SetExportEdgesLock
public virtual HRESULT SetExportEdgesLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ExportEdgesLock setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetExportNormals
-
Sets the ExportNormals parameter (exported Vrml files will or will not contains normal informations).
- Parameters:
-
- iExportNormals
- Value of ExportNormals parameter.
Legal values:
TRUE : exported Vrml files will contain normal informations.
FALSE : exported Vrml files will not contain normal informations.
o SetExportNormalsLock
public virtual HRESULT SetExportNormalsLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ExportNormalsLock setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetExportTexture
-
Sets the ExportTexture parameter (exported Vrml files will or will not contains texture informations).
- Parameters:
-
- iExportTexture
- Value of ExportTexture parameter.
Legal values:
TRUE : exported Vrml files will contain texture informations.
FALSE : exported Vrml files will not contain texture informations.
o SetExportTextureFile
public virtual HRESULT SetExportTextureFile( | const unsigned int | iExportTextureFile)= 0 |
-
Sets the ExportTextureFile parameter (Textures will be exported in the vrml file containing the geometry
or in external files).
- Parameters:
-
- iExportTextureFile
- Value of ExportTextureFile parameter.
Legal values:
0 : Textures are exported in the Vrml file containing the geometry.
1 : Texture are exported in external files.
o SetExportTextureFileLock
public virtual HRESULT SetExportTextureFileLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ExportTextureFile setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetExportTextureFormat
public virtual HRESULT SetExportTextureFormat( | const unsigned int | iExportTextureFormat)= 0 |
-
DO NOT USE.
Sets the ExportTextureFormat parameter.
- Parameters:
-
- iExportTextureFormat
- Value of ExportTextureFormat parameter.
Legal values:
NOT APPLICABLE
o SetExportTextureFormatLock
public virtual HRESULT SetExportTextureFormatLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ExportTextureFile setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetExportTextureLock
public virtual HRESULT SetExportTextureLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ExportTextureLock setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetExportVersion
public virtual HRESULT SetExportVersion( | const unsigned int | iExportVersion)= 0 |
-
Sets the ExportVersion parameter (version of exported Vrml files).
- Parameters:
-
- iExportVersion
- Value of Import Unit parameter.
Legal values:
1 : VRML 1.0.
2 : VRML 97 (VRML 2.0).
o SetExportVersionLock
public virtual HRESULT SetExportVersionLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ExportVersionLock setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetImportCreaseAngle
public virtual HRESULT SetImportCreaseAngle( | const float | iImportCreaseAngle)= 0 |
-
Sets the ImportCreaseAngle parameter.
The crease angle affects how DEFAULT normals are generated. If the angle between the geometric normals of two
adjacent faces is less than the crease angle, normals will be calculated so that the faces are smooth-shaded
across the edge. Otherwise, normals will be calculated so that a lighting discontinuity across the edge is
produce.
- Parameters:
-
- iImportCreaseAngle
- Value of ImportCreaseAngle parameter.
Legal values:
[0,inf]
o SetImportCreaseAngleLock
public virtual HRESULT SetImportCreaseAngleLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ImportCreaseAngle setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetImportUnit
public virtual HRESULT SetImportUnit( | const unsigned int | iImportUnit)= 0 |
-
Sets the ImportUnit parameter (unit of imported Vrml files).
- Parameters:
-
- iImportUnit
- Value of Import Unit parameter.
Legal values:
0 : Millimeter.
1 : Centimeter.
2 : Meter.
o SetImportUnitLock
public virtual HRESULT SetImportUnitLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ImportUnit setting parameter.
Refer to
CATSysSettingController for a detailed description.
This object is included in the file: CATIVisVrmlSettingAtt.h
If needed, your Imakefile.mk should include the module: CATVisualization