All Frameworks  Class Hierarchy  This Framework  Indexes   

Visualization Interface 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 GetExportBackgroundColorInfo(CATSettingInfo*)
Retrieves information about the ExportBackgroundColor setting parameter.
o GetExportBackgroundColor(unsigned int*,unsigned int*,unsigned int*)
Returns the ExportBackgroundColor parameter (Background color of exported Vrml files).
o GetExportEdgesInfo(CATSettingInfo*)
Retrieves information about the ExportEdges setting parameter.
o GetExportEdges(CATBoolean&)
Returns the ExportEdges parameter (exported Vrml files will or will not contains edge informations).
o GetExportNormalsInfo(CATSettingInfo*)
Retrieves information about the ExportNormals setting parameter.
o GetExportNormals(CATBoolean&)
Returns the ExportNormals parameter (exported Vrml files will or will not contains normal informations).
o GetExportTextureFileInfo(CATSettingInfo*)
Retrieves information about the ExportTextureFile setting parameter.
o GetExportTextureFile(unsigned int&)
Returns the ExportTextureFile parameter (Textures will be exported in the vrml file containing the geometry or in external files).
o GetExportTextureFormatInfo(CATSettingInfo*)
Retrieves information about the ExportTextureFile setting parameter.
o GetExportTextureFormat(unsigned int&)
DO NOT USE.
o GetExportTextureInfo(CATSettingInfo*)
Retrieves information about the ExportTexture setting parameter.
o GetExportTexture(CATBoolean&)
Returns the ExportTexture parameter (exported Vrml files will or will not contains texture informations).
o GetExportVersionInfo(CATSettingInfo*)
Retrieves information about the ExportVersion setting parameter.
o GetExportVersion(unsigned int&)
Returns the ExportVersion parameter (version of exported Vrml files).
o GetImportCreaseAngleInfo(CATSettingInfo*)
Retrieves information about the ImportCreaseAngle setting parameter.
o GetImportCreaseAngle(float&)
Returns the ImportCreaseAngle parameter.
o GetImportUnitInfo(CATSettingInfo*)
Retrieves information about the ImportUnit setting parameter.
o GetImportUnit(unsigned int&)
Returns the ImportUnit parameter (unit of imported Vrml files).
o SetExportBackgroundColorLock(unsigned char)
Locks or unlocks the ExportBackgroundColor setting parameter.
o SetExportBackgroundColor(unsigned int,unsigned int,unsigned int)
Sets the ExportBackgroundColor parameter (Background color of exported Vrml files).
o SetExportEdgesLock(unsigned char)
Locks or unlocks the ExportEdgesLock setting parameter.
o SetExportEdges(CATBoolean)
Sets the ExportEdges parameter (exported Vrml files will or will not contains edge informations).
o SetExportNormalsLock(unsigned char)
Locks or unlocks the ExportNormalsLock setting parameter.
o SetExportNormals(CATBoolean)
Sets the ExportNormals parameter (exported Vrml files will or will not contains normal informations).
o SetExportTextureFileLock(unsigned char)
Locks or unlocks the ExportTextureFile setting parameter.
o SetExportTextureFile(unsigned int)
Sets the ExportTextureFile parameter (Textures will be exported in the vrml file containing the geometry or in external files).
o SetExportTextureFormatLock(unsigned char)
Locks or unlocks the ExportTextureFile setting parameter.
o SetExportTextureFormat(unsigned int)
DO NOT USE.
o SetExportTextureLock(unsigned char)
Locks or unlocks the ExportTextureLock setting parameter.
o SetExportTexture(CATBoolean)
Sets the ExportTexture parameter (exported Vrml files will or will not contains texture informations).
o SetExportVersionLock(unsigned char)
Locks or unlocks the ExportVersionLock setting parameter.
o SetExportVersion(unsigned int)
Sets the ExportVersion parameter (version of exported Vrml files).
o SetImportCreaseAngleLock(unsigned char)
Locks or unlocks the ImportCreaseAngle setting parameter.
o SetImportCreaseAngle(float)
Sets the ImportCreaseAngle parameter.
o SetImportUnitLock(unsigned char)
Locks or unlocks the ImportUnit setting parameter.
o SetImportUnit(unsigned int)
Sets the ImportUnit parameter (unit of imported Vrml files).

Methods


o GetExportBackgroundColorInfo
public virtual GetExportBackgroundColorInfo( oInfo)
Retrieves information about the ExportBackgroundColor setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExportBackgroundColor
public virtual GetExportBackgroundColor( ioR,
ioG,
ioB)
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 GetExportEdgesInfo
public virtual GetExportEdgesInfo( oInfo)
Retrieves information about the ExportEdges setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExportEdges
public virtual GetExportEdges( oExportEdges)
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 GetExportNormalsInfo
public virtual GetExportNormalsInfo( oInfo)
Retrieves information about the ExportNormals setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExportNormals
public virtual GetExportNormals( oExportNormals)
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 GetExportTextureFileInfo
public virtual GetExportTextureFileInfo( oInfo)
Retrieves information about the ExportTextureFile setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExportTextureFile
public virtual GetExportTextureFile( oExportTextureFile)
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 GetExportTextureFormatInfo
public virtual GetExportTextureFormatInfo( oInfo)
Retrieves information about the ExportTextureFile setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExportTextureFormat
public virtual GetExportTextureFormat( oExportTextureFormat)
DO NOT USE. Returns the ExportTextureFormat parameter.
Parameters:
oExportTextureFormat
Value of ExportTextureFormat parameter. Legal values:
NOT APPLICABLE
o GetExportTextureInfo
public virtual GetExportTextureInfo( oInfo)
Retrieves information about the ExportTexture setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExportTexture
public virtual GetExportTexture( oExportTexture)
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 GetExportVersionInfo
public virtual GetExportVersionInfo( oInfo)
Retrieves information about the ExportVersion setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetExportVersion
public virtual GetExportVersion( oExportVersion)
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 GetImportCreaseAngleInfo
public virtual GetImportCreaseAngleInfo( oInfo)
Retrieves information about the ImportCreaseAngle setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetImportCreaseAngle
public virtual GetImportCreaseAngle( oImportCreaseAngle)
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 GetImportUnitInfo
public virtual GetImportUnitInfo( oInfo)
Retrieves information about the ImportUnit setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetImportUnit
public virtual GetImportUnit( oImportUnit)
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 SetExportBackgroundColorLock
public virtual SetExportBackgroundColorLock( iLocked)
Locks or unlocks the ExportBackgroundColor setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExportBackgroundColor
public virtual SetExportBackgroundColor( const iR,
const iG,
const iB)
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 SetExportEdgesLock
public virtual SetExportEdgesLock( iLocked)
Locks or unlocks the ExportEdgesLock setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExportEdges
public virtual SetExportEdges( const iExportEdges)
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 SetExportNormalsLock
public virtual SetExportNormalsLock( iLocked)
Locks or unlocks the ExportNormalsLock setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExportNormals
public virtual SetExportNormals( const iExportNormals)
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 SetExportTextureFileLock
public virtual SetExportTextureFileLock( iLocked)
Locks or unlocks the ExportTextureFile setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExportTextureFile
public virtual SetExportTextureFile( const iExportTextureFile)
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 SetExportTextureFormatLock
public virtual SetExportTextureFormatLock( iLocked)
Locks or unlocks the ExportTextureFile setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExportTextureFormat
public virtual SetExportTextureFormat( const iExportTextureFormat)
DO NOT USE. Sets the ExportTextureFormat parameter.
Parameters:
iExportTextureFormat
Value of ExportTextureFormat parameter. Legal values:
NOT APPLICABLE
o SetExportTextureLock
public virtual SetExportTextureLock( iLocked)
Locks or unlocks the ExportTextureLock setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExportTexture
public virtual SetExportTexture( const iExportTexture)
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 SetExportVersionLock
public virtual SetExportVersionLock( iLocked)
Locks or unlocks the ExportVersionLock setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetExportVersion
public virtual SetExportVersion( const iExportVersion)
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 SetImportCreaseAngleLock
public virtual SetImportCreaseAngleLock( iLocked)
Locks or unlocks the ImportCreaseAngle setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetImportCreaseAngle
public virtual SetImportCreaseAngle( const iImportCreaseAngle)
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 SetImportUnitLock
public virtual SetImportUnitLock( iLocked)
Locks or unlocks the ImportUnit setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetImportUnit
public virtual SetImportUnit( const iImportUnit)
Sets the ImportUnit parameter (unit of imported Vrml files).
Parameters:
iImportUnit
Value of Import Unit parameter. Legal values:
0 : Millimeter.
1 : Centimeter.
2 : Meter.

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

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