=== enum_CatArrangeStyle_19809 ===
InfInterfaces CatArrangeStyleEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatArrangeStyle (Enumeration)
enum CatArrangeStyle {
catArrangeCascade,
catArrangeTiledHorizontal,
catArrangeTiledVertical
}
Window arrangement style.
Values:
catArrangeCascade
The windows are superimposed, the first one being located in the
upper left corner, each other window being shifted to the bottom
and to the right from the previous one, so that their title bar
and a thin left strip of each is visible, except for the last
one which is fully visible.
catArrangeTiledHorizontal
The windows are arranged as non-overlapping horizontal tiles
catArrangeTiledVertical
The windows are arranged as non-overlapping vertical tiles
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATBackFaceCullingMode_31680 ===
InfInterfaces CATBackFaceCullingModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATBackFaceCullingMode (Enumeration)
enum CATBackFaceCullingMode {
CATBackFaceCullingOnSolidFaces,
CATBackFaceCullingOnAllFaces,
CATBackFaceCullingOnStandAloneFaces,
CATBackFaceCullingOnNoFaces
}
Back Face Culling mode.
Values:
CATBackFaceCullingOnSolidFaces
The Back Face Culling algorithm is applied only to faces belonging to solids. This is the default behavior.
CATBackFaceCullingOnAllFaces
The Back Face Culling algorithm is applied both on faces belonging to solids and also on stand-alone faces.
CATBackFaceCullingOnStandAloneFaces
The Back Face Culling algorithm is applied only to stand-alone faces.
CATBackFaceCullingOnNoFaces
The Back Face Culling algorithm is not applied to any faces.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatBannerPosition_23300 ===
InfInterfaces CatBannerPositionEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatBannerPosition (Enumeration)
enum CatBannerPosition {
catBannerPositionNone,
catBannerPositionBottom,
catBannerPositionTop,
catBannerPositionLeft,
catBannerPositionRight
}
Banner position.
This banner is used by the  object for document printing.
It is composed of a customized text, and possibly a logo.
Values:
catBannerPositionNone
The print has no banner
catBannerPositionBottom
The banner is located along the bottom side of the print
catBannerPositionTop
The banner is located along the top side of the print
catBannerPositionLeft
The banner is located along the left side of the print
catBannerPositionRight
The banner is located along the right side of the print
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatCameraType_16851 ===
InfInterfaces CatCameraTypeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatCameraType (Enumeration)
enum CatCameraType {
catCamera2D,
catCamera3D
}
Types of camera.
Values:
catCamera2D
A 2D camera for Viewer2D objects
catCamera2D
A 3D camera for Viewer3D objects
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatCaptureFormat_21416 ===
InfInterfaces CatCaptureFormatEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatCaptureFormat (Enumeration)
enum CatCaptureFormat {
catCaptureFormatCGM,
catCaptureFormatEMF,
catCaptureFormatTIFF,
catCaptureFormatTIFFGreyScale,
catCaptureFormatBMP,
catCaptureFormatJPEG,
catCaptureFormatPDF,
catCaptureFormatSVG
}
File format in which the capture of a viewer can be saved.
It is used by the  object.
Values:
catCaptureFormatCGM
The viewer is captured and a CGM file is generated
catCaptureFormatEMF
The viewer is captured and a Windows Enhanced Metafile is generated
catCaptureFormatTIFF
The viewer is captured and a TIFF file is generated
catCaptureFormatTIFFGreyScale
The viewer is captured and a greyscale TIFF file is generated
catCaptureFormatBMP
The viewer is captured and a BMP file is generated
catCaptureFormatJPEG
The viewer is captured and a JPEG file is generated
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatClippingMode_19494 ===
InfInterfaces CatClippingModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatClippingMode (Enumeration)
enum CatClippingMode {
catClippingModeClear,
catClippingModeNear,
catClippingModeFar,
catClippingModeNearAndFar
}
Depth effects.
They are used by the  object.
Values:
catClippingModeClear
The clear depth effect. All objects are displayed.
catClippingModeNear
The scene is clipped by the near plane only. Any object
between the eye and the near plane is not visible.
catClippingModeFar
The scene is clipped by the far plane only. Any object
beyond the far plane is not visible.
catClippingModeNearAndFar
The foggy depth effect. Fog is added in the background to
progressively dissimulate far objects. This increases the display
performance when a great number of objects are displayed.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATDocContextualPriority_38535 ===
InfInterfaces CATDocContextualPriorityEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATDocContextualPriority (Enumeration)
enum CATDocContextualPriority {
CATDocContextualTechDoc,
CATDocContextualUserComp
}
The Contextual Priority setting attribute range of values.
Role: This enum is used in the  interface.
Values:
CATDocContextualTechDoc
The documentation is launched first
CATDocContextualUserComp
The User Companion is launched first
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatFileSelectionMode_28162 ===
InfInterfaces CatFileSelectionModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatFileSelectionMode (Enumeration)
enum CatFileSelectionMode {
CatFileSelectionModeOpen,
CatFileSelectionModeSave
}
Mode used when displaying a file selection box using CATIA.
FileSelectionBox.
Values:
CatFileSelectionModeOpen
The selection box is used to get the name of a file to open.
CatFileSelectionModeSave
The selection box is used to get the name of a file to save.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATFullSceneAntiAliasingMode_46652 ===
InfInterfaces CATFullSceneAntiAliasingModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATFullSceneAntiAliasingMode (Enumeration)
enum CATFullSceneAntiAliasingMode {
CATFSAAMode_Deactivated,
CATFSAAMode_2xSuperSampling,
CATFSAAMode_4xSuperSampling,
CATFSAAMode_8xSuperSampling,
CATFSAAMode_16xSuperSampling
}
Full Scene Anti-aliasing mode.
Values:
CATFSAAMode_Deactivated
The Full Scene Anti-aliasing is deactivated. This is the default behavior.
CATFSAAMode_2xSuperSampling
The Full Scene Anti-aliasing mode is set to 2 times super sampling.
CATFSAAMode_4xSuperSampling
The Full Scene Anti-aliasing mode is set to 4 times super sampling.
CATFSAAMode_8xSuperSampling
The Full Scene Anti-aliasing mode is set to 8 times super sampling.
CATFSAAMode_16xSuperSampling
The Full Scene Anti-aliasing mode is set to 16 times super sampling.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATGenConferencing_24553 ===
InfInterfaces CATGenConferencingEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATGenConferencing (Enumeration)
enum CATGenConferencing {
NetMeeting,
Backbone
}
The Conference Driver setting attribute range of values.
This property is not available on UNIX
Role: This enum is used in the  interface.
Values:
NetMeeting
Microsoft� Windows� NetMeeting�
Backbone
Backbone
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATGenDataSave_17712 ===
InfInterfaces CATGenDataSaveEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATGenDataSave (Enumeration)
enum CATGenDataSave {
NoAutoBackup,
AutoBackupEvery,
IncrBackup
}
The Data Save setting attribute range of values.
Role: This enum is used in the  interface.
Values:
NoAutoBackup
No automatic backup
AutoBackupEvery
Automatic backup every...
IncrBackup
Incremental backup
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATGenUIStyle_16537 ===
InfInterfaces CATGenUIStyleEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATGenUIStyle (Enumeration)
enum CATGenUIStyle {
UIStyleP1,
UIStyleP2,
UIStyleP3
}
The User Interface Style setting attribute range of values.
Role: This enum is used in the  interface.
Values:
UIStyleP1
Look is P1
UIStyleP2
Look is P2
UIStyleP3
Look is P3
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatImageRotation_21435 ===
InfInterfaces CatImageRotationEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatImageRotation (Enumeration)
enum CatImageRotation {
catImageNoRotation,
catImageRotation90,
catImageRotation180,
catImageRotation270,
catImageBestRotation
}
Image rotation.
It is used by the  object for document printing.
The image rotation angle is counted clockwise.
Values:
catImageNoRotation
The image is not rotated
catImageRotation90
The image is rotated of 90 degrees clockwise
catImageRotation180
The image is rotated of 180 degrees clockwise
catImageRotation270
The image is rotated of 270 degrees clockwise
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatLightingMode_19479 ===
InfInterfaces CatLightingModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatLightingMode (Enumeration)
enum CatLightingMode {
catInfiniteLightSource,
catNeonLightSource
}
Lighting modes.
They are used by the  object.
Values:
catInfiniteLightSource
An infinite light source
catNeonLightSource
A light source simulating a set of parallel neon tubes.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATMultiSelectionMode_30283 ===
InfInterfaces CATMultiSelectionModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATMultiSelectionMode (Enumeration)
enum CATMultiSelectionMode {
CATMonoSel,
CATMultiSelTriggWhenSelPerf,
CATMultiSelTriggWhenUserValidatesSelection
}
Types of multi-selection.
Role: This enum is used by the  method.
Values:
CATMonoSel
Multi-selection is not supported
CATMultiSelTriggWhenSelPerf
Multi-selection is supported (through a dedicated "Tools Palette" toolbar).
The selection (through a trap for example) is triggered when the selection is performed.
The CTRL and SHIFT keys are not supported.
CATMultiSelTriggWhenUserValidatesSelection
Multi-selection is supported (through a dedicated "Tools Palette" toolbar).
The selection (through a trap for example) is triggered when the user validates the selection.
The CTRL and SHIFT keys are supported.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatNavigationStyle_25064 ===
InfInterfaces CatNavigationStyleEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatNavigationStyle (Enumeration)
enum CatNavigationStyle {
catNavigationExamine,
catNavigationWalk,
catNavigationFly
}
Navigation styles.
They are used by the  object.
Values:
catNavigationExamine
The examining navigation style. Examining means that you move
the scene but you don't move yourself.
catNavigationWalk
The walking navigation style. When you choose this style and moves the
mouse on the scene, it changes as if you were walking in.
catNavigationFly
The flying navigation style. When you choose this style and moves the
mouse on the scene, it changes as if you were flying in.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatPaperOrientation_27011 ===
InfInterfaces CatPaperOrientationEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatPaperOrientation (Enumeration)
enum CatPaperOrientation {
catPaperPortrait,
catPaperLandscape,
catPaperBestFit
}
Paper orientation.
It is used by the  object for document printing.
Values:
catPaperPortrait
The portrait paper orientation
catPaperLandscape
The landscape paper orientation
catPaperBestFit
The paper orientation, chosen among portrait and landscape when
printing, to best fit the printed image into the available space
in the sheet of paper.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatPaperSize_15659 ===
InfInterfaces CatPaperSizeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatPaperSize (Enumeration)
enum CatPaperSize {
catPaperLetter,
catPaperLegal,
catPaperA0,
catPaperA1,
catPaperA2,
catPaperA3,
catPaperA4,
catPaperA,
catPaperB,
catPaperC,
catPaperD,
catPaperE,
catPaperF,
catPaperUser
}
Paper size.
It used by the  object for document printing.
Values:
catPaperLetter
The US Letter format (8.5 x 11")
catPaperLegal
The Legal format (8.5 x 14")
catPaperA0
The A0 ISO format (841 x 1189 mm)
catPaperA1
The A1 ISO format (594 x 841 mm)
catPaperA2
The A2 ISO format (420 x 594 mm)
catPaperA3
The A3 ISO format (297 x 420 mm)
catPaperA4
The A4 ISO format (210 x 297 mm)
catPaperA
The A ANSI format (8.5 x 11")
catPaperB
The B ANSI format (11 x 17")
catPaperC
The C ANSI format (17 x 22")
catPaperD
The D ANSI format (22 x 34")
catPaperE
The E ANSI format (34 x 44")
catPaperF
The F ANSI format (28 x 40")
catPaperUser
The customized format
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatPrintColor_17024 ===
InfInterfaces CatPrintColorEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatPrintColor (Enumeration)
enum CatPrintColor {
catColorTrueColor,
catColorGreyScale,
catColorMonochrome
}
Color Appearance.
It is used by the  object for document printing.
Values:
catColorTrueColor
The three components red, green and blue are used.
catColorGreyScale
The grey scale color is obtain by the formula : 0.3f*red + 0.59f*green + 0.11f*blue.
catColorMonochrome
Only black or white color.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatPrinterDirState_24588 ===
InfInterfaces CatPrinterDirStateEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatPrinterDirState (Enumeration)
enum CatPrinterDirState {
CatPrinterDirFree,
CatPrinterDirProtect
}
Printer directory state.
It is used by the  object for modify the printers setting. Each directory can be protected to prevent user access to the printers it contains.
The state could be "CATPrinterDirFree" or "CATPrinterDirProtect"
Values:
CATPrinterDirFree
The parameters of each printer included in the directory
can be changed, and the printers can be removed.
CATPrinterDirProtect
The parameters of each printer included in the directory
cannot be changed.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatPrintLineCap_19217 ===
InfInterfaces CatPrintLineCapEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatPrintLineCap (Enumeration)
enum CatPrintLineCap {
catPrintFlat,
catPrintSquare,
catPrintRound
}
CatPrintLineCap.
It used by the  object for document printing.
Values:
catPrintFlat
The line ends are printed flat.
catPrintSquare
The line ends are printed squared.
catPrintRound
The line ends are printed round.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatPrintLineSpecification_39999 ===
InfInterfaces CatPrintLineSpecificationEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatPrintLineSpecification (Enumeration)
enum CatPrintLineSpecification {
catPrintAbsolute,
catPrintScaled,
catPrintNoThickness
}
CatPrintLineSpecification
It used by the
object for document printing.
Values:
catPrintAbsolute
The line width and the line type are independant of the image scale.
catPrintScaled
The line width and the line type depend of the image scale.
catPrintNoThickness
The line width is 0.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatPrintQuality_20141 ===
InfInterfaces CatPrintQualityEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatPrintQuality (Enumeration)
enum CatPrintQuality {
catPrintQualityDraft,
catPrintQualityLow,
catPrintQualityMedium,
catPrintQualityHigh,
catPrintQualityCustom
}
Print quality.
It is used by the  object for document printing. The print quality ranges from catPrintQualityDraft to
catPrintQualityHigh and applies to shaded images.
catPrintQualityDraft is the lowest quality and creates images
with the screen
resolution (It is for example the Quality 0 for HP-GL/2.)
catPrintQualityHigh prints images at the maximum
printer resolution.
The other print qualities are somewhere in between.
Values:
catPrintQualityDraft
The print quality is acceptable for drafts
catPrintQualityLow
The print quality is low
catPrintQualityMedium
The print quality is medium
catPrintQualityHigh
The print quality is high
catPrintQualityCustom
The print quality is custom
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatPrintRenderingMode_30274 ===
InfInterfaces CatPrintRenderingModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatPrintRenderingMode (Enumeration)
enum CatPrintRenderingMode {
catPrintRenderingModeDefault,
catPrintRenderingModeWireframe,
catPrintRenderingModeHiddenLineRemoval,
catPrintRenderingModeShadingWithTriangles,
catPrintRenderingModeDynamicHiddenLineRemoval,
catPrintRenderingModeOnScreen
}
Print rendering mode.
It is used by the  object for document printing. The print rendering ranges from catPrintRenderingModeDefault to
catPrintRenderingModeOnScreen.
The print rendering mode are :
Values:
catPrintRenderingModeDefault
The print rendering is based on the visualization rendering
catPrintRenderingModeWireframe
The print rendering is wireframe
catPrintRenderingModeHiddenLineRemoval
The print rendering is hidden line removal
catPrintRenderingModeShadingWithTriangles
The print rendering is shading with triangles
catPrintRenderingModeDynamicHiddenLineRemoval
The print rendering is dynamic hidden line removal
catPrintRenderingModeOnScreen
The print rendering is on screen
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatProjectionMode_22819 ===
InfInterfaces CatProjectionModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatProjectionMode (Enumeration)
enum CatProjectionMode {
catProjectionConic,
catProjectionCylindric,
catProjectionUndefined
}
Projection modes.
They are used by the  object.
Values:
catProjectionConic
The conic, or perspective projection mode
catProjectionCylindric
The cylindric, or parallel projection mode
catProjectionUndefined
No specific projection mode (for cameras only)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatRenderingMode_21006 ===
InfInterfaces CatRenderingModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatRenderingMode (Enumeration)
enum CatRenderingMode {
catRenderShading,
catRenderShadingWithEdges,
catRenderWireFrame,
catRenderHiddenLinesRemoval,
catRenderQuickHiddenLinesRemoval,
catRenderMaterial,
catRenderMaterialWithEdges,
catRenderShadingWithEdgesAndHiddenEdges,
catRenderShadingWithEdgesWithoutSmoothEdges,
catRenderWireFrameWithoutSmoothEdgesWithoutVertices,
catRenderWireFrameWithHalfSmoothEdgesWithoutVertices,
catRenderShadingWithEdgesWithOutlines,
catRenderQuickHiddenLinesRemovalWithoutVertices,
catRenderQuickHiddenLinesRemovalWithHiddenEdgesWithOutlines,
catRenderQuickHiddenLinesRemovalWithHiddenEdgesWithOutlinesWithoutVertices,
catRenderWireFrameWithHalfSmoothEdgeWithOutlinesWithoutVertices,
catRenderWireFrameWithOutlinesWithoutSmoothEdgesWithoutVertices,
catRenderQuickHiddenLinesRemovalWithHiddenEdgesWithoutSmoothEdgesWithoutVertices,
catRenderQuickHiddenLinesRemovalWithHiddenEdgesWithHalfSmoothEdgeWithoutVertices,
catRenderQuickHiddenLinesRemovalWithoutSmoothEdgesWithoutVertices,
catRenderQuickHiddenLinesRemovalWithHalfSmoothEdgeWithoutVertices,
catRenderShadingWithEdgesWithHalfSmoothEdgeWithoutVertices,
catRenderShadingWithEdgesWithHalfSmoothEdge
}
Rendering modes.
They are used by the  object.
Values:
catRenderShading
The shading rendering mode
catRenderShadingWithEdges
The shading rendering mode with edges shown
catRenderWireFrame
The wireframe rendering mode
catRenderHiddenLinesRemoval
The hidden removal rendering mode
catRenderQuickHiddenLinesRemoval
The quick hidden removal rendering mode
catRenderMaterial
The material rendering mode
catRenderMaterialWithEdges
The material rendering mode with edges shown
catRenderShadingWithEdgesAndHiddenEdges
The shading rendering mode with edges and hidden edges shown
catRenderShadingWithEdgesWithoutSmoothEdges
The wireframe rendering mode without smooth edges without vertices
catRenderWireFrameWithoutSmoothEdgesWithoutVertices
The wireframe rendering mode with half smooth edges without vertices
catRenderWireFrameWithHalfSmoothEdgesWithoutVertices
The shading rendering mode with wiht edges with outlines
catRenderShadingWithEdgesWithOutlines
The quick hidden removal rendering mode without vertices
catRenderQuickHiddenLinesRemovalWithoutVertices
The quick hidden removal rendering mode with hidden edges with outlines
catRenderQuickHiddenLinesRemovalWithHiddenEdgesWithOutlines
The quick hidden removal rendering mode with hidden edges with outlines without vertices
catRenderQuickHiddenLinesRemovalWithHiddenEdgesWithOutlinesWithoutVertices
The wireframe rendering mode with half smooth edges with outlines without vertices
catRenderWireFrameWithHalfSmoothEdgeWithOutlinesWithoutVertices
The wireframe rendering mode with outlines without smooth edges without vertices
catRenderWireFrameWithOutlinesWithoutSmoothEdgesWithoutVertices
The quick hidden removal rendering mode with hidden edges without smooth edges without vertices
catRenderQuickHiddenLinesRemovalWithHiddenEdgesWithoutSmoothEdgesWithoutVertices
The quick hidden removal rendering mode with hidden edges with half smooth edges without vertices
catRenderQuickHiddenLinesRemovalWithHiddenEdgesWithHalfSmoothEdgeWithoutVertices
The quick hidden removal rendering mode without smooth edges vithout vertices
catRenderQuickHiddenLinesRemovalWithoutSmoothEdgesWithoutVertices
The quick hidden removal rendering mode with half smooth edges without vertices
catRenderQuickHiddenLinesRemovalWithHalfSmoothEdgeWithoutVertices
The Shading rendering mode with half smooth edges without vertices
catRenderShadingWithEdgesWithHalfSmoothEdgeWithoutVertices
The Shading rendering mode with half smooth edges
catRenderShadingWithEdgesWithHalfSmoothEdge
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATSearchContextScope_30583 ===
InfInterfaces CATSearchContextScopeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATSearchContextScope (Enumeration)
enum CATSearchContextScope {
Everywhere,
InWorkbench,
FromWorkbench,
FromSelection,
VisibleOnScreen
}
The Default Power Input Context Scope setting attribute range of values.
Role: This enum is used in the  interface.
Values:
Everywhere
shortcut "all"
InWorkbench
shortcut "in"
FromWorkbench
shortcut "from"
FromSelection
shortcut "sel"
VisibleOnScreen
shortcut "scr"
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CATSelectionFilter_24727 ===
InfInterfaces CATSelectionFilterEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CATSelectionFilter (Enumeration)
enum CATSelectionFilter {
ZeroDim,
MonoDim,
MonoDimInfinite,
RectilinearMonoDim,
RectilinearMonoDimInfinite,
BiDim,
BiDimInfinite,
PlanarBiDim,
PlanarBiDimInfinite,
CylindricalBiDim,
TriDim
}
Values to use as selection filter.
Role: Values which can be given as filter to ,
,
or
, beside the automation object names.
Values:
ZeroDim
Topological 0-D entity (such as a
)
MonoDim
Topological 1-D entity which cannot be infinite (such as a
)
MonoDimInfinite
Topological 1-D entity which may be infinite, such as a
(not infinite) or a
for which a call to
would give 1, 2 or 3 (infinite)
RectilinearMonoDim
1-D entity which cannot be infinite, the entity having a rectilinear geometry
RectilinearMonoDimInfinite
1-D entity which may be infinite, the entity having a rectilinear geometry
BiDim
Topological 2-D entity which cannot be infinite (such as a
)
BiDimInfinite
Topological 2-D entity which may be infinite, such as a
(non infinite) or a
(infinite)
PlanarBiDim
2-D entity which cannot be infinite, the entity having a planar geometry
PlanarBiDimInfinite
2-D entity having a planar geometry
CylindricalBiDim
2-D entity which cannot be infinite, the entity having a cylindrical geometry
TriDim
Topological 3-D entity (such as a
)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatSpecsAndGeomWindowLayout_45462 ===
InfInterfaces CatSpecsAndGeomWindowLayoutEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatSpecsAndGeomWindowLayout (Enumeration)
enum CatSpecsAndGeomWindowLayout {
catWindowSpecsOnly,
catWindowGeomOnly,
catWindowSpecsAndGeom
}
Specification and geometry window layout.
It is used by the  object.
Values:
catWindowSpecsOnly
The specification tree viewer only is displayed
catWindowGeomOnly
The geometry 3D viewer only is displayed
catWindowSpecsAndGeom
The specification tree viewer and the geometry 3D viewer are both
displayed
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatSpecsLayout_18552 ===
InfInterfaces CatSpecsLayoutEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatSpecsLayout (Enumeration)
enum CatSpecsLayout {
catSpecsViewerHorizontalIndented,
catSpecsViewerHorizontalUp,
catSpecsViewerHorizontalCentered,
catSpecsViewerVerticalCentered,
catSpecsViewerHorizontalRelational,
catSpecsViewerVerticalRelational
}
Specification tree layout.
It is used by the  object.
Values:
catSpecsViewerHorizontalIndented
The specification tree is indented horizontally (classical Windows style)
catSpecsViewerHorizontalUp
The specification tree is indented horizontally (structure)
catSpecsViewerHorizontalCentered
The specification tree is centered horizontally (constructive historic, horizontal)
catSpecsViewerVerticalCentered
The specification tree is centered vertically (constructive historic, vertical)
catSpecsViewerHorizontalRelational
The specification tree is centered horizontally (relational, horizontal)
catSpecsViewerVerticalRelational
The specification tree is centered vertically (relational, horizontal)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatTreeOrientationEnum_33035 ===
InfInterfaces CatTreeOrientationEnumEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatTreeOrientationEnum (Enumeration)
enum CatTreeOrientationEnum {
catTreeOrientationVertical,
catTreeOrientationHorizontal
}
Orientations for the specification tree.
Role: This enum is used in the  interface.
Values:
catTreeOrientationVertical
The tree is oriented vertically.
catTreeOrientationHorizontal
The tree is oriented horizontally.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatTreeSizeTypeEnum_26467 ===
InfInterfaces CatTreeSizeTypeEnumEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatTreeSizeTypeEnum (Enumeration)
enum CatTreeSizeTypeEnum {
catTreeSizeTypeFixedSize,
catTreeSizeTypeTextDependentSize
}
Types for the size of the text in the specification tree.
Role: This enum is used in the  interface.
Values:
catTreeSizeTypeFixedSize
Only a fixed number of characters are shown in the specification tree,
for names of its items.
catTreeSizeTypeTextDependentSize
The integrality of each item's name is shown.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatTreeTypeEnum_19646 ===
InfInterfaces CatTreeTypeEnumEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatTreeTypeEnum (Enumeration)
enum CatTreeTypeEnum {
catTreeTypeClassical,
catTreeTypeStructural,
catTreeTypeHistorical,
catTreeTypeRelational
}
Types for the specification tree.
Role: This enum is used in the  interface.
Values:
catTreeTypeClassical
Classical Windows style tree.
catTreeTypeStructural
Structure-oriented representation of the tree.
catTreeTypeHistorical
Constructive historic representation of the tree.
catTreeTypeRelational
Relation-oriented representation of the tree.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatVisLayerType_19778 ===
InfInterfaces CatVisLayerTypeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatVisLayerType (Enumeration)
enum CatVisLayerType {
catVisLayerBasic,
catVisLayerNone
}
Types of layer.
Role: This enum is used in the  interface.
Values:
catVisLayerBasic
basic layer
This type of layer gets a number from 1 to 1000.
catVisLayerNone
"None" layer
An object which has a "None" layer does not have any specific layer.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatVisPropertyPick_24881 ===
InfInterfaces CatVisPropertyPickEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatVisPropertyPick (Enumeration)
enum CatVisPropertyPick {
catVisPropertyPickAttr,
catVisPropertyNoPickAttr
}
Types of Pick/NoPick states.
Role: This enum is used in the  interface.
Values:
catVisPropertiesPickAttr
The Pick state
catVisPropertiesNoPickAttr
The No Pick state
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatVisPropertyShow_25304 ===
InfInterfaces CatVisPropertyShowEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatVisPropertyShow (Enumeration)
enum CatVisPropertyShow {
catVisPropertyShowAttr,
catVisPropertyNoShowAttr
}
Types of Show/NoShow states.
Role: This enum is used in the  interface.
Values:
catVisPropertyShowAttr
The show state
catVisPropertyNoShowAttr
The No Show state
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatVisPropertyStatus_29500 ===
InfInterfaces CatVisPropertyStatusEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatVisPropertyStatus (Enumeration)
enum CatVisPropertyStatus {
catVisPropertyDefined,
catVisPropertyUnDefined
}
Types of result of a query on graphic properties for the current selection.
Role: This enum is used in the  interface.
Values:
catVisPropertyDefined
All selected objects have the same graphic properties.
catVisPropertyUnDefined
At least one of selected objects does not have the same graphic properties than
other the selected objects.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatVisPropertyType_25283 ===
InfInterfaces CatVisPropertyTypeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatVisPropertyType (Enumeration)
enum CatVisPropertyType {
catVisPropertyLineType,
catVisPropertyWidth,
catVisPropertyColor,
catVisPropertyOpacity
}
Types of graphic properties.
Role: This enum is used in the  interface.
Values:
catVisPropertyLineType
The line type
catVisPropertyWidth
The line width
catVisPropertyColor
The color
catVisPropertyOpacity
The opacity
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatWindowState_18366 ===
InfInterfaces CatWindowStateEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatWindowState (Enumeration)
enum CatWindowState {
catWindowStateMaximized,
catWindowStateMinimized,
catWindowStateNormal
}
Window state.
Values:
catWindowStateMaximized
The window occupies the whole screen
catWindowStateMinimized
The window is reduced to an icon
catWindowStateNormal
The window occupies the space either the application or the end user
has determined
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Application_17729 ===
InfInterfaces Application (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Application (Object)
Represents the current CNext application and its frame window.
The application is the root object for all the other objects you can use
and access from scripts. It directly aggregates:
The document collection represented by the  object. This collection contains all the documents currently opened by the
application
The window collection represented by the
object. This collection contains all the windows currently opened by the
application, each window displaying one of the documents contained in
the document collection
The
object, providing information about the system environment.
The active document and the active window are two key objects for the
application you can access using the
and
properties respectively. The active window is the window the end user is
currently working in, and the active document is the document displayed
in this active window and that the end user is being editing.
This document sets its workshop, that is the available menus and
toolbars that make it possible to edit it, according to its type.
When you create or use macros for in-process access, the application
is always referred to as CATIA.
Property Index
ActiveDocument
Returns the active document.
ActivePrinter
Returns or sets the active printer.
ActiveWindow
Returns the active window.
CacheSize
Returns or sets the default local cache size used by the application.
Caption
Returns or sets the application's window title.
DisplayFileAlerts
Returns or sets the application ability to display file alerts.
Documents
Returns the collection of documents currently managed by the application.
FileSearchOrder
Returns or sets the default path concatenation.
FileSystem
Returns the file system.
FullName
Returns the application's executable file full name, including its path.
HSOSynchronized
For selection performance purposes, returns or sets the HSO synchronization in comparison with the CSO.
Height
Returns or sets the height of the application's frame window.
Interactive
Returns or sets the application sensitivity to end user interactions.
Left
Returns or sets the distance from the application's frame window
left side to the left side of the screen.
LocalCache
Returns or sets the default local cache path used by the application.
Path
Returns the path of the application's executable files.
Printers
Returns the collection of the printers currently managed by the application.
RefreshDisplay
Enables or disables the update of the display during the script replay.
StatusBar
Returns or sets the text displayed in the application's window
status bar.
SystemConfiguration
Returns the system configuration object (an object which
provides access to system or configuration dependent resources).
SystemService
Returns system services.
Top
Returns or sets the distance from the application'si frame window
top to the top of the screen.
UndoRedoLock
Returns or sets the application status about Undo/Redo.
Visible
Returns or sets the application's window visibility.
Width
Returns or sets the width of the application's frame window.
Windows
Returns the collection of windows currently managed by the application.
Method Index
BeginURConcatenation
Start to concatenate the undo steps created during the following code.
CreateSendTo
Creates a Send TO.
DisableNewUndoRedoTransaction
Prevents new Undo/Redo transaction creation.
EnableNewUndoRedoTransaction
Allows new Undo/Redo transaction creation.
FileSelectionBox
Displays a modal dialog box which can be used to select / enter
the name of a file to open / save.
GetWorkbenchId
Returns the identifier of the CATIA current workbench.
Help
Displays application's online help.
Quit
Exits the application and closes all open documents.
StartCommand
Starts a CATIA command.
StartWorkbench
Starts a CATIA workbench.
StopURConcatenation
Concatenate all the undo steps created since the start call.
Properties
Property ActiveDocument() As   (Read Only)
Returns the active document.
The active document is the document the end user is being editing.
Beware, the active document API shouldn't be used in batch environment, in batch
context retrieve your document from Documents collection.
Example:
This example retrieves in ActiveDoc the active
document of the CATIA application.
Dim ActiveDoc As Document
Set ActiveDoc = CATIA.ActiveDocument
Property ActivePrinter() As
Returns or sets the active printer.
The active printer is the printer on which documents are printed
Example:
This example retrieves in ActivePrinter the active
printer of the CATIA application.
Dim ActivePrinter As Printer
Set ActivePrinter = CATIA.ActivePrinter
Property ActiveWindow() As   (Read Only)
Returns the active window.
The active window is the window in which the end user is currently
editing the active document.
Example:
This example retrieves in ActiveWin the active
window of the CATIA application.
Dim ActiveWin As Window
Set ActiveWin = CATIA.ActiveWindow
Property CacheSize() As
Returns or sets the default local cache size used by the application.
Example:
This example sets the cache size for by the CATIA
application to those defined in LocalCacheSize.
LocalCacheSize= 10
CATIA.CacheSize = LocalCacheSize
Property Caption() As
Returns or sets the application's window title.
This title is displayed in the application's window title bar.
Example:
This example retrieves in Title the CATIA
application's window title.
Title = CATIA.Caption
The returned value is like this:
CNext
Property DisplayFileAlerts() As
Returns or sets the application ability to display file alerts.
True if the application enables file alert display.
True is the default. A file alert is, for example, the dialog box
that prompts you that the file you want to save is in read only mode,
or that the file you want to close needs to be saved.
It could be handy to disable these file alerts for automation since they
may freeze your macro execution, waiting for an end user input in the
displayed dialog box.
Example:
This example disables file alerts for the CATIA application.
CATIA.DisplayFileAlerts = False
Property Documents() As   (Read Only)
Returns the collection of documents currently managed by the application.
Example:
This example retrieves in DocCollection the collection of
documents currently managed by the CATIA application.
Dim DocCollection As Documents
Set DocCollection = CATIA.Documents
Property FileSearchOrder() As
Returns or sets the default path concatenation.
Role: This property returns or sets the default path concatenation used
by Other folders setting of the Linked Documents Localization function.
The primary aim of the Linked Documents Localization function
is to resolve document links and to manage the strategy
that will be used to locate your linked documents.
Example:
This example sets the paths to search for by the CATIA
application to those defined in PathConcatenation.
PathConcatenation = "/u/users/fbq/db/model:/u/users/psr/db/model"
CATIA.FileSearchOrder = PathConcatenation
Theese methods require the installation of CATIA - PPR xPDM Gateway 1 Product (PX1)
In case this product is not granted, the first invocation to one of the methods will fail.
Property FileSystem() As   (Read Only)
Returns the file system.
The file system provides access to a computer's file system.
Example:
This example retrieves in AppliFileSys the file
sytem of the CATIA application.
Dim AppliFileSys As FileSystem
Set AppliFileSys = CATIA.FileSystem
Property FullName() As   (Read Only)
Returns the application's executable file full name, including its path.
This name is the name of the executable file used to start
the application.
Example:
This example retrieves in ApplicationFullName the
CATIA application's executable file full name.
ApplicationFullName = CATIA.FullName
The returned value is like this:
\\lisa\cxr1arel\bsf\alpha_a\code\bin\CNEXT.exe
Property HSOSynchronized() As
For selection performance purposes, returns or sets the HSO synchronization in comparison with the CSO.
Role: Precises if, for all
object instances, the HSO (Highlighted Set of Objects) is synchronized in comparison with the CSO (Current Set of Objects).
Valid values are:
True: In this case, Selection methods work directly with CATIA's CSO, to reflect instantly the changes made in Automation Selection.
This ensures correct selection results, but may impact performance in certain cases.
This is the default value at the beginning of a CATIA session.
False: In this case, Selection methods work with an internal SO buffer, which allows faster execution
when performing a large number of CSO-independent Selection calls, or when performing a single Selection call working on a large number of objects (usually the Search method). This may also prevent the features from blinking between two user interactions.
Note: even if this property is set to False, the HSO is synchronized in comparison with the CSO at the begining of the following methods:
Selection.SelectElement2
Selection.SelectElement3
Selection.SelectElement4
Selection.IndicateOrSelectElement2D
Selection.IndicateOrSelectElement3D
Application.StartCommand
CAUTION: If you use the False value of this property, you must make sure to reset it to True for CATIA's CSO to reflect properly the changes made in Automation Selection. For example, it should be reset to True before interactive parts of your script: MsgBox, InputBox calls, VBA forms updates and so on.
Property Height() As
Returns or sets the height of the application's frame window.
The height is expressed in pixels.
Example:
This example sets the height of the CATIA
application's frame window to 300 pixels.
CATIA.Height = 300
Property Interactive() As
Returns or sets the application sensitivity to end user interactions.
True if the application is end user interaction sensitive.
Example:
This example makes the CATIA application sensitive
to end user interactions.
CATIA.Interactive = True
Property Left() As
Returns or sets the distance from the application's frame window
left side to the left side of the screen.
This distance is expressed in pixels.
Example:
This example sets the distance from the CATIA
application's frame window left side to the left side of the screen
to 150 pixels.
CATIA.Left = 150
Property LocalCache() As
Returns or sets the default local cache path used by the application.
Example:
This example sets the cache path for by the CATIA
application to those defined in LocalCachePath.
LocalCachePath= "/tmp/cache"
CATIA.LocalCache = LocalCachePath
Property Path() As   (Read Only)
Returns the path of the application's executable files.
Example:
This example retrieves in ApplicationPath the path where the
CATIA application executable files are located.
ApplicationPath = CATIA.Path
The returned value is like this:
\\lisa\cxr1arel\bsf\alpha_a\code\bin
Property Printers() As   (Read Only)
Returns the collection of the printers currently managed by the application.
Example:
This example retrieves in PrintersCollection the collection of the
printers currently managed by the CATIA application.
Dim PrintersCollection As Windows
Set PrintersCollection = CATIA.Printers
Property RefreshDisplay() As
Enables or disables the update of the display during the script replay.
To improve performance, this update can be temporarely disabled by setting
this property to False in the script.
True (value set by default) if the application's display is refreshed after each method call
executed in late binding mode .
This property does not affect early binding calls nor the get methods because they are never followed
by a refresh of the display.
Example:
This example makes the update of the CATIA application's display disabled during the script replay.
CATIA.RefreshDisplay = False
Property StatusBar() As
Returns or sets the text displayed in the application's window
status bar.
Example:
This example retrieves in Text the text displayed in the
CATIA application's window status bar.
Text = CATIA.StatusBar
The returned value is like this:
Welcome to CATIA CxR1
Property SystemConfiguration() As   (Read Only)
Returns the system configuration object (an object which
provides access to system or configuration dependent resources).
Parameters:
oConfiguration
The system configuration object.
Property SystemService() As   (Read Only)
Returns system services.
Example:
This example retrieves in AppliSysSer the CATIA
application's system services.
Dim AppliSysSer As SystemService
Set AppliSysSer = CATIA.SystemService
Property Top() As
Returns or sets the distance from the application'si frame window
top to the top of the screen.
This distance is expressed in pixels.
Example:
This example sets the distance from the CATIA
application's frame window top to the top of the screen to 50 pixels.
CATIA.Top = 50
Property UndoRedoLock() As
Returns or sets the application status about Undo/Redo.
True if the Undo/Redo mechanism is locked.
False is the default. Since Undo/Redo mechanism uses lots of memory,
it can be useful to disable it during consuming operations.
Then Undo and Redo stacks are flushed and no model modification
is kept until the Undo/Redo mechanism is unlocked.
It is mandatory to unlock it before the end of the macro.
Example:
This example disables Undo/Redo mechanism until it is unlocked.
CATIA.UndoRedoLock = True
Property Visible() As
Returns or sets the application's window visibility.
True if the application's window is visible to the end user.
Example:
This example makes the CATIA application's window visible.
CATIA.Visibility = True
Property Width() As
Returns or sets the width of the application's frame window.
The width is expressed in pixels.
Example:
This example sets the width of the CATIA
application's frame window to 350 pixels.
CATIA.Width = 350
Property Windows() As   (Read Only)
Returns the collection of windows currently managed by the application.
Example:
This example retrieves in WinCollection the collection of
windows currently managed by the CATIA application.
Dim WinCollection As Windows
Set WinCollection = CATIA.Windows
Methods
Sub BeginURConcatenation()
Start to concatenate the undo steps created during the following code.
Using this API will launch a dummy command in order to close
all current model transaction. This is to avoid to left the model
in an unconsitent state.
Func CreateSendTo() As
Creates a Send TO.
Role:This method creates a
instance.
Warning : CATIASendToService interface requires
the installation of CATIA - PPR xPDM Gateway 1 Product (PX1)
In case this product is not granted, the first invocation to one of CATIASendToService methods will fail.
Sub DisableNewUndoRedoTransaction()
Prevents new Undo/Redo transaction creation.
If too many Undo/Redo transactions are created during macro execution, it may affect performance.
So it is valuable to prevent Undo/Redo transaction creation during macro execution when lots
of data are created, deleted or modified.
Note: preventing Undo/Redo transaction creation must not be done when a selection is required
in the macro
Do not forget to call
at the end of the macro or before selection to restore the common behavior.
Example:
This example prevents new transactions to be created, which may increase performance.
CATIA.DisableNewUndoRedoTransaction()
Sub EnableNewUndoRedoTransaction()
Allows new Undo/Redo transaction creation.
Example:
This example restores the common behavior after
has been called.
CATIA.EnableNewUndoRedoTransaction()
Func FileSelectionBox( iTitle, iExtension, iMode) As
Displays a modal dialog box which can be used to select / enter
the name of a file to open / save.
Parameters:
iTitle
The title of the dialog box.
iExtension
A file extension filter.
iMode
The mode in which to run the dialog box (either CatFileSelectionModeOpen or
CatFileSelectionModeSave.
oFilePath
The return string containing the full path of the selected file, or a zero-length
string if the user selects Cancel.
Example:
This example asks the user to select a text file and prints the path of the selected
file.
filepath = CATIA.FileSelectionBox("Select a text file", "*.txt", CatFileSelectionModeOpen)
CATIA.SystemServices.Print "The selected file is " & filepath
Func GetWorkbenchId() As
Returns the identifier of the CATIA current workbench.
Parameters:
oworkbenchId
The id of the current workbench.
Sub Help( iHelpID)
Displays application's online help.
Parameters:
iHelpID
Identifier of the help message to display
Example:
This example displays the string referred to by the HelpKey
message key in the message catalog concatenation.
CATIA.Help("HelpKey")
Sub Quit()
Exits the application and closes all open documents.
Example:
This example exits the CATIA application
and closes all its open documents.
CATIA.Quit()
Sub StartCommand( iCommandId)
Starts a CATIA command.
Role:This method starts a command and executes it untill its first interaction.
Please notice interactions such as selections you could add after in your macro will not work.
StartCommand is useful to execute one-shot (not interactive) commands, it is not safe for interactive commands.
Parameters:
iCommandId
The id of the command to be started. This id can be the name of the
command or its alias.
Sub StartWorkbench( iworkbenchId)
Starts a CATIA workbench.
Parameters:
iworkbenchId
The id of the workbench to be started.
Sub StopURConcatenation( iUndoStepNameBSTR)
Concatenate all the undo steps created since the start call.
Parameters:
iUndoStepNameBSTR
Name of the undo step that will be created
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Camera2D_14156 ===
InfInterfaces Camera2D (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Camera2D (Object)
Represents a 2D camera.
The 2D camera stores a 2D viewpoint, that is
a  object.
Property Index
Viewpoint2D
Returns or sets the 2D viewpoint of a 2D camera.
Properties
Property Viewpoint2D() As
Returns or sets the 2D viewpoint of a 2D camera.
Example:
Assume the active window is a
object. This example retrieves the
of the
and creates
from it a Camera2D you handle using the MyCamera variable.
Then the camera zoom is set to 2, and the
camera's viewpoint is assigned to the
.
Dim MyCamera As Camera
Set MyCamera = CATIA.ActiveWindow.SpecsViewer.NewCamera()
MyCamera.Viewpoint2D.Zoom = 2
CATIA.ActiveWindow.SpecsViewer.Viewpoint2D = MyCamera.Viewpoint2D
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Camera3D_14162 ===
InfInterfaces Camera3D (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Camera3D (Object)
Represents a 3D camera.
The 3D camera stores a 3D viewpoint, that is
a  object.
Property Index
Viewpoint3D
Returns or sets the 3D viewpoint of a 3D camera.
Properties
Property Viewpoint3D() As
Returns or sets the 3D viewpoint of a 3D camera.
Example:
Assume the active window is a
object. This example retrieves the
of the active 3D viewer and creates from it a Camera3D you handle using the MyCamera
variable.
Then the camera zoom is set to 2, and the
camera's viewpoint is assigned to the active viewer.
Dim MyCamera As Camera3D
Set MyCamera = CATIA.ActiveWindow.ActiveViewer.NewCamera()
MyCamera.Viewpoint3D.Zoom = 2
CATIA.ActiveWindow.ActiveViewer.Viewpoint3D = MyCamera.Viewpoint3D
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Camera_13380 ===
InfInterfaces Camera (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Camera (Object)
Represents the camera.
The camera is the object that stores a viewpoint saved from a viewer
at a given moment using the  method of the
object. The viewpoint stored in the camera can then be applied to another viewer
to display the document in this viewer according to this viewpoint.
Property Index
Type
Returns the camera's type.
Properties
Property Type() As   (Read Only)
Returns the camera's type.
Example:
This example retrieves in MyCameraType the type of the
MyCamera 3D camera and applies the viewpoint stored in
this camera to the active viewer.
MyCameraType = MyCamera.Type
CATIA.ActiveWindow.ActiveViewer.Viewpoint3D = MyCamera.Viewpoint3D
The value returned by the Type property in MyCameraType
is catCamera3D
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Cameras_14070 ===
InfInterfaces Cameras (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Cameras (Object)
A collection of all the Camera objects currently attached to a
Document object.
A camera can be created using the  method of the
object. The first seventh cameras of the collection are
objects and cannot be modified or removed.
They can just be retrieved and used "as is". They store the following
viewpoints whose sight direction is always toward the 3D-axis system
origin:
* iso
The origin is on a line with (1,1,1) as components with
positive coordinates
* front
The origin is on the x axis with a positive x coordinate
* back
The origin is on the x axis with a negative x coordinate
* left
The origin is on the y axis with a positive y coordinate
* right
The origin is on the y axis with a negative y coordinate
* top
The origin is on the z axis with a positive z coordinate
* bottom
The origin is on the z axis with a negative z coordinate
The cameras of the Cameras collection are available using the
dialog box displayed by clicking the View->Defined Views menu.
Method Index
Item
Returns a camera using its index or its name from the Cameras collection.
Remove
Removes a camera from the Cameras collection.
Methods
Func Item( iIndex) As
Returns a camera using its index or its name from the Cameras collection.
Parameters:
iIndex
The index or the name of the camera to retrieve from
the collection of cameras.
As a numerics, this index is the rank of the camera
in the collection.
The index of the first camera in the collection is 1, and
the index of the last camera is Count.
As a string, it is the name you assigned to the camera using
the
property.
Returns:
The retrieved camera
Example:
This example retrieves in ThisCamera the ninth camera,
and in ThatCamera the camera named
MyCamera in the camera collection of the active document.
Dim ThisCamera As Camera
Set ThisCamera = CATIA.ActiveDocument.Cameras.Item(9)
Dim ThatCamera As Camera
Set ThatCamera = CATIA.ActiveDocument.Cameras.Item("MyCamera")
Sub Remove( iIndex)
Removes a camera from the Cameras collection.
Parameters:
iIndex
The index or the name of the camera to remove from
the collection of cameras.
As a numerics, this index is the rank of the camera
in the collection.
The index of the first camera in the collection is 1, and
the index of the last camera is Count.
As a string, it is the name you assigned to the camera using
the
property.   You cannot remove the first seventh cameras in the collection.
Example:
The following example removes the tenth camera and the camera named
CameraToBeRemoved in the camera collection
of the active document.
CATIA.ActiveDocument.Cameras.Remove(10)
CATIA.ActiveDocument.Cameras.Remove("CameraToBeRemoved")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_CGRAdhesionSettingAtt_33558 ===
InfInterfaces CGRAdhesionSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
CGRAdhesionSettingAtt (Object)
Represents the base object to handle the parameters of the cache.
Property Index
V4V5_FDT
Retrieves the V4V5_FDT container activation state.
V4_Model_CommentPage
Retrieves the V4_Model_CommentPage container activation state.
V4_Model_LnF
Retrieves the V4_Model_LnF container activation state.
V5_SPA
Retrieves the V5_SPA container activation state.
Voxels
Retrieves the Voxels container activation state.
Method Index
GetV4V5_FDTInfo
Retrieves information about the V4V5_FDT container activation state.
GetV4_Model_CommentPageInfo
Locks or unlocks the V4_Model_CommentPage container activation state.
GetV4_Model_LnFInfo
Retrieves information about the V4_Model_LnF container activation state.
GetV5_SPAInfo
Retrieves information about the V5_SPA container activation state.
GetVoxelsInfo
Retrieves information about the Voxels container activation state.
SetV4V5_FDTLock
Locks or unlocks the V4V5_FDT container activation state.
SetV4_Model_CommentPageLock
Retrieves information about the V4_Model_CommentPage container activation state.
SetV4_Model_LnFLock
Locks or unlocks the V4_Model_LnF container activation state.
SetV5_SPALock
Locks or unlocks the V5_SPA container activation state.
SetVoxelsLock
Locks or unlocks the Voxels container activation state.
Properties
Property V4V5_FDT() As
Retrieves the V4V5_FDT container activation state.
Property V4_Model_CommentPage() As
Retrieves the V4_Model_CommentPage container activation state.
Property V4_Model_LnF() As
Retrieves the V4_Model_LnF container activation state.
Property V5_SPA() As
Retrieves the V5_SPA container activation state.
Property Voxels() As
Retrieves the Voxels container activation state.
Methods
Func GetV4V5_FDTInfo( AdminLevel, oLocked) As
Retrieves information about the V4V5_FDT container activation state.
Refer to
CATSysSettingController for a detailed description.
Func GetV4_Model_CommentPageInfo( AdminLevel, oLocked) As
Locks or unlocks the V4_Model_CommentPage container activation state.
Refer to
CATSysSettingController for a detailed description.
Func GetV4_Model_LnFInfo( AdminLevel, oLocked) As
Retrieves information about the V4_Model_LnF container activation state.
Refer to
CATSysSettingController for a detailed description.
Func GetV5_SPAInfo( AdminLevel, oLocked) As
Retrieves information about the V5_SPA container activation state.
Refer to
CATSysSettingController for a detailed description.
Func GetVoxelsInfo( AdminLevel, oLocked) As
Retrieves information about the Voxels container activation state.
Refer to
CATSysSettingController for a detailed description.
Sub SetV4V5_FDTLock( iLocked)
Locks or unlocks the V4V5_FDT container activation state.
Refer to
CATSysSettingController for a detailed description.
Sub SetV4_Model_CommentPageLock( iLocked)
Retrieves information about the V4_Model_CommentPage container activation state.
Refer to
CATSysSettingController for a detailed description.
Sub SetV4_Model_LnFLock( iLocked)
Locks or unlocks the V4_Model_LnF container activation state.
Refer to
CATSysSettingController for a detailed description.
Sub SetV5_SPALock( iLocked)
Locks or unlocks the V5_SPA container activation state.
Refer to
CATSysSettingController for a detailed description.
Sub SetVoxelsLock( iLocked)
Locks or unlocks the Voxels container activation state.
Refer to
CATSysSettingController for a detailed description.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Document_14894 ===
InfInterfaces Document (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Document (Object)
Represents the document.
The document is the object handled by the operating system as a whole
that stores your data in files and databases.
It is assigned a type determined by its contents. It may contain other
documents with a different type. For example,
a PartDocument contains a part and can be contained in a ProductDocument.
A workshop is associated with a document to gather all the commands
that can be used to create, modify, and edit the objects making up the
the document. These commands are arranged in menus and toolbars.
See also:
, ,
Property Index
Cameras
Returns the document's collection of cameras.
CurrentFilter
Returns or sets the current visualization filter.
CurrentLayer
Returns or sets the current layer.
FullName
Returns the document's full file name, including its path.
Path
Returns the document's file path.
ReadOnly
Returns whether the file containing the document can be read only,
on can be read and written.
Saved
Returns whether the document has been modified, and thus needs to be
saved.
SeeHiddenElements
Returns or sets the document's hidden elements visibility.
Selection
Returns the current selection.
Method Index
Activate
Activates the document.
Close
Closes the document.
CreateFilter
Creates a new visualization filter from a name and a definition.
CreateReferenceFromName
Creates a reference from a GenericNaming label.
ExportData
Exports the data contained in the document to another format.
GetWorkbench
Returns one of the workbenches of the document.
Indicate2D
Runs an 2D interactive indication command.
Indicate3D
Runs an 3D interactive indication command.
NewWindow
Duplicates the window which contains the active document.
RemoveFilter
Removes an existing visualization filter.
Save
Saves the document.
SaveAs
Saves the document with another name.
Properties
Property Cameras() As   (Read Only)
Returns the document's collection of cameras.
Example:
This example retrieves in CameraCollection the collection of
cameras attached to the Doc document.
Dim CameraCollection As Cameras
Set CameraCollection = Doc.Cameras
Property CurrentFilter() As
Returns or sets the current visualization filter.
CurrentFilter uses the filter name and not its definition.
The "All visible" filter means that all layers are visible.
For all filters, remind that the current layer is always visible.
Example:
This example makes the filter named "Filter001" as the current visualization filter
for the Doc document.
Doc.CurrentFilter = "Filter001"
Property CurrentLayer() As
Returns or sets the current layer.
CurrentLayer uses the layer name and not its number.
The "None" layer means that there is no current layer.
Example:
This example makes the layer named "Layer 3" as the current layer
for the Doc document.
Doc.CurrentLayer = "Layer 3"
Property FullName() As   (Read Only)
Returns the document's full file name, including its path.
Example:
This example retrieves in DocFullName the Doc
document's full file name.
DocFullName = Doc.FullName
The returned value is like this:
e:\users\psr\Parts\MyNicePart.CATPart
Property Path() As   (Read Only)
Returns the document's file path.
Example:
This example retrieves in DocPath the path where the
Doc document is stored.
DocPath = Doc.Path
The returned value is like this:
e:\users\psr\Parts
Property ReadOnly() As   (Read Only)
Returns whether the file containing the document can be read only,
on can be read and written.
True if the file is read-only.
Example:
This example retrieves in IsReadOnly the ability to read,
and possibly to write in, the file containing the Doc document.
IsReadOnly = Doc.ReadOnly
Property Saved() As   (Read Only)
Returns whether the document has been modified, and thus needs to be
saved.
This happens when the document has changed since either its creation or
its last save.
True if the document has not been changed: the document doesn't need to be saved.
False if the document has been changed: the document needs to be saved.
Example:
This example retrieves in HasChanged whether the Doc
document needs to be saved.
HasChanged = NOT Doc.Saved
Property SeeHiddenElements() As
Returns or sets the document's hidden elements visibility.
True if the document's hidden elements are visible to the user.
Example:
This example makes the Doc document's hidden elements visible.
Doc.SeeHiddenElements = True
Property Selection() As   (Read Only)
Returns the current selection.
The current selection is the object or the set of objects the end user
has selected, usually with the mouse, in the active document displayed
in the active window.
Example:
This example returns in CurSel the current selection
in the Doc document
Dim CurSel As Selection
Set CurSel = Doc.Selection
Methods
Sub Activate()
Activates the document.
Activating a document means that this document is the one on which
the end user is now working on. This document possibly reconfigures
the menu bar and toolbars with its own commands if its type
is different from the type of the previous active document.
The first window in the window collection which contains this
document becomes the active one.
Example:
This example activates the Doc document.
Doc.Activate()
Sub Close()
Closes the document.
This closes all the windows displaying the document.
If the document needs to be saved, the end user is prompted
whether to save the document, or to close it anyway.
Example:
This example closes the Doc document
Doc.Close()
Sub CreateFilter( iFilterName, iFilterDefinition)
Creates a new visualization filter from a name and a definition.
Fails if there is already a filter named iFilterName.
Parameters:
iFilterName
The filter name.
iFilterDefinition
The filter definition
Example:
This example creates the filter named "Filter001" and with "layer= 2 & layer= 1" definition
for the Doc document.
Doc.CreateFilter ("Filter001", "layer= 2 & layer= 1")
Func CreateReferenceFromName( iLabel) As
Creates a reference from a GenericNaming label.
Each kind of document provides a specific implementation.
Parameters:
iLabel
The GenericNaming identification for an object.
Returns:
The reference to the object.
Sub ExportData( fileName, format)
Exports the data contained in the document to another format.
Parameters:
fileName
The name of the exported file
format
The name of the format
Example:
This example writes the Doc document in the IGES format
under the IGESDoc name.
Doc.ExportData("IGESDoc", "igs")
Func GetWorkbench( workbenchName) As
Returns one of the workbenches of the document.
Parameters:
workbenchName
The name of the workbench
Example:
This example retrieves the Structural workbench on the Doc
document
Doc.GetWorkbench("Structural")
Func Indicate2D( iMessage, ioDocumentWindowLocation) As
Runs an 2D interactive indication command.
Role: Indicate2D asks to the user to select a location
in the document window. It can be used:
When this document is a
When this document is a
, and a sketch is  being edited (
has been called and
has not been called yet)
See also:
which can, in particular, enable indication and not selection (positionning the iFilterType parameter to an empty string), whichs enables to subscribe to mouse move
events, positionning the iTriggeringOnPreSelection to true.
Note:If the scripting language is Visual Basic for Applications or Visual Basic 6 Development Studio, then,
you have to know that during the execution of an interactive selection method such as this one, no form
(dialog box) must be displayed, otherwise it would lead to unpredictible results. In a form method, before
calling an interactive selection method such as Document.Indicate2D, you must hide all forms, and, after the
call to the method, you must show the forms.
Parameters:
iMessage
A string which instructs the user that he must select a location in the document window.
This string is displayed in the message area located at the left of the power input area.
oDocumentWindowLocation
An array made of 2 doubles: X, Y - coordinates array of the location
the user specified in the document window.
oOutputState
The state of the indication command once Indicate2D returns.
It can be either "Normal" (the indication has succeeded), "Cancel" (the user wants to cancel the VB command,
which must exit immediately, see the oOutputState parameter of the
method), "Undo" or "Redo". About the use of "Undo" and "Redo", see the example of the
method.
Example:
The following example suppose a drawing document is currently edited. It asks the end user to select a
location in the current drawing window, and creates a text (see
) at the specified location:
Set Document = CATIA.ActiveDocument : Set Selection = Document.Selection : Set DrawingSheets  = Document.Sheets
Set DrawingSheet = DrawingSheets.ActiveSheet : Set DrawingViews = DrawingSheet.Views
Set DrawingView = DrawingViews.ActiveView : Set DrawingTexts = DrawingView.Texts
'We propose to the user that he specify a location in the drawing window
Dim DrawingWindowLocation(1)
Status=Document.Indicate2D("select a location into the drawing window",DrawingWindowLocation)
if (Status = "Cancel") then Exit Sub
Set DrawingText=DrawingTexts.Add("Hello world",DrawingWindowLocation(0),DrawingWindowLocation(1))
Func Indicate3D( iPlanarGeometricObject, iMessage, ioWindowLocation2D, ioWindowLocation3D) As
Runs an 3D interactive indication command.
Role: Indicate3D asks to the user to select a location
in the document window. It cannot be used:
When this document is a
When this document is a
, and a sketch is  being edited (
has been called and
has not been called yet)
In these cases, Indicate2D must be used.
See also:
which can, in particular, enable indication and not selection (positionning the iFilterType parameter to an empty string), whichs enables to subscribe to mouse move
events, positionning the iTriggeringOnPreSelection to true.
Note:If the scripting language is Visual Basic for Applications or Visual Basic 6 Development Studio, then,
you have to know that during the execution of an interactive selection method such as this one, no form
(dialog box) must be displayed, otherwise it would lead to unpredictible results. In a form method, before
calling an interactive selection method such as Document.Indicate2D, you must hide all forms, and, after the
call to the method, you must show the forms.
Parameters:
iPlanarGeometricObject
A planar geometric object.
The following objects are supported:
,
,
,
,
,
,
,
and
.
iMessage
A string which instructs the user that he must select a location in the document window.
This string is displayed in the message area located at the left of the power input area.
oWindowLocation2D
An array made of 2 doubles: X, Y - coordinates array of the location
the user specified in the document window, in the input planar object
coordinates system
oWindowLocation3D
An array made of 3 doubles: X, Y, Z - coordinates array of the location
the user specified in the document window
oOutputState
The state of the indication command once Indicate3D returns.
It can be either "Normal" (the indication has succeeded), "Cancel" (the user wants to cancel the VB command,
which must exit immediately, see the oOutputState parameter of the
method), "Undo" or "Redo". About the use of "Undo" and "Redo", see the example of the
method.
Example:
The following example asks the end user to select a location in the
document window, on the Plane.1 plane, and creates a
at the specified location:
Set Document = CATIA.ActiveDocument : Set Part  = Document.Part : Set Selection = Document.Selection
Set HybridShapeFactory = Part.HybridShapeFactory
Set HybridShapePlane = Part.Bodies.Item("PartBody").HybridShapes.Item("Plane.1")
Set PlaneReference = Part.CreateReferenceFromObject(HybridShapePlane)
'We propose to the user that he select a location in the window
ReDim WindowLocation2D(1),WindowLocation3D(2)
Status=Document.Indicate3D(HybridShapePlane,"select a location in the document window", _
WindowLocation2D,WindowLocation3D)
if (Status = "Cancel") then Exit Sub
Set HybridShapePointOnPlane = HybridShapeFactory.AddNewPointOnPlane( _
PlaneReference,WindowLocation2D(0),WindowLocation2D(1))
Part.Bodies.Item("PartBody").InsertHybridShape HybridShapePointOnPlane
Part.InWorkObject = HybridShapePointOnPlane
Part.Update
Func NewWindow() As
Duplicates the window which contains the active document.
This implies creating a window, displaying the active document in this window
with the same view point, making this window the active one, and adding the window
to the collection of windows.
Example:
This example creates the MyWindow new window for
the Doc document.
Dim MyWindow As Window
Set MyWindow = Doc.NewWindow()
Sub RemoveFilter( iFilterName)
Removes an existing visualization filter.
Fails if the filter to be removed is the current filter.
Parameters:
iFilterName
The filter name.
Example:
This example removes the filter named "Filter001" for the Doc document.
Doc.RemoveFilter ("Filter001")
Sub Save()
Saves the document.
Example:
This example saves the Doc document.
Doc.Save()
Sub SaveAs( fileName)
Saves the document with another name.
Parameters:
fileName
The name to assign to the document
Example:
This example saves the Doc document with the NewName
name.
Doc.SaveAs("NewName")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_DocumentationSettingAtt_38404 ===
InfInterfaces DocumentationSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
DocumentationSettingAtt (Object)
Setting controller for the Help property tab page.
Role: This interface is implemented by a component which
represents the controller of the documentation settings.
Property Index
CompanionPath
Returns the User Companion location (path) parameter.
DocLanguage
Returns the technical documentation language parameter.
Priority
Returns the contextual priority parameter.
TechnicalDocumentationPath
Returns the technical documentation location (path) parameter.
Method Index
GetCompanionPathInfo
Retrieves environment informations for the User Companion location parameter.
GetDocLanguageInfo
Retrieves environment informations for the technical documentation language parameter.
GetPriorityInfo
Retrieves environment informations for the contextual priority parameter.
GetTechnicalDocumentationPathInfo
Retrieves environment informations for the technical documentation location parameter.
SetCompanionPathLock
Locks or unlocks the User Companion location parameter.
SetDocLanguageLock
Locks or unlocks the technical documentation language parameter.
SetPriorityLock
Locks or unlocks the contextual priority parameter.
SetTechnicalDocumentationPathLock
Locks or unlocks the technical documentation location parameter.
Properties
Property CompanionPath() As
Returns the User Companion location (path) parameter.
Property DocLanguage() As
Returns the technical documentation language parameter.
Property Priority() As
Returns the contextual priority parameter.
Property TechnicalDocumentationPath() As
Returns the technical documentation location (path) parameter.
Methods
Func GetCompanionPathInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the User Companion location parameter.
Role:Retrieves the state of the User Companion location parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetDocLanguageInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the technical documentation language parameter.
Role:Retrieves the state of the technical documentation language parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetPriorityInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the contextual priority parameter.
Role:Retrieves the state of the contextual priority parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetTechnicalDocumentationPathInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the technical documentation location parameter.
Role:Retrieves the state of the technical documentation location parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub SetCompanionPathLock( iLocked)
Locks or unlocks the User Companion location parameter.
Role:Locks or unlocks the User Companion location 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.
Sub SetDocLanguageLock( iLocked)
Locks or unlocks the technical documentation language parameter.
Role:Locks or unlocks the technical documentation language 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.
Sub SetPriorityLock( iLocked)
Locks or unlocks the contextual priority parameter.
Role:Locks or unlocks the contextual priority 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.
Sub SetTechnicalDocumentationPathLock( iLocked)
Locks or unlocks the technical documentation location parameter.
Role:Locks or unlocks the technical documentation location 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.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Documents_15814 ===
InfInterfaces Documents (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Documents (Object)
A collection of all the Document objects currently managed by the
application.
These documents belong to one of the following types:
PartDocument, ProductDocument, and Drawing.
See also:
, ,
Method Index
Add
Creates a Document object and adds it to the documents collection.
Item
Returns a document using its index or its name from the documents
collection.
NewFrom
Creates a new document from a document stored in a file.
Open
Opens a document stored in a file.
Read
Reads a document stored in a file.
Methods
Func Add( docType) As
Creates a Document object and adds it to the documents collection.
This document becomes the active one, and a window is created to
accomodate it which becomes the active window.
Parameters:
docType
The type of the document to create, chosen among:
Part    For PartDocument
Product For ProductDocument
Drawing For Drawing
Returns:
The created document
Example:
The following example creates a PartDocument document in the collection
retrieved in PartDoc.
Dim PartDoc As Document
Set PartDoc = Documents.Add("Part")
Func Item( iIndex) As
Returns a document using its index or its name from the documents
collection.
Parameters:
iIndex
The index or the name of the document to retrieve frm
the collection of documents.
As a numerics, this index is the rank of the document
in the collection.
The index of the first document in the collection is 1, and
the index of the last document is Count.
As a string, it is the name you assigned to the document using
the
property.
Returns:
The retrieved document Example:
This example retrieves in ThisDoc the fifth document
in the collection and in ThatDoc the document
named MyDoc.
Dim ThisDoc As Document
Set ThisDoc = Documents.Item(5)
Dim ThatDoc As Document
Set ThatDoc = Documents.Item("MyDoc")
Func NewFrom( iFileName) As
Creates a new document from a document stored in a file.
Role: Reads a document stored in a file and creates a
new document containing the resulting data, adds the new document
to the document collection, displays it in a new window, adds
the window to the window collection and activates both the
document and the window.
Parameters:
The
name of the file containing the document.
Returns:
The created document.
Example:
The following example creates a new Doc document
from the contents of the FileToRead file.
FileToRead = "e:\users\psr\Parts\ThisIsANicePart.CATPart"
Dim Doc As Document
Set Doc = Documents.NewFrom(FileToRead)
Func Open( iFileName) As
Opens a document stored in a file.
Reads a document stored in a file, displays it in a new window, adds
the document to the documents collection and the window to the
windows collection, and
makes both the document and the window the active ones.
Parameters:
iFileName
The name of the file containing the document
Returns:
The retrieved document Example:
The following example opens the Doc document
contained in the FileToOpen file.
FileToOpen = "e:\users\psr\Parts\ThisIsANicePart.CATPart"
Dim Doc As Document
Set Doc = Documents.Open(FileToOpen)
Func Read( iFileName) As
Reads a document stored in a file.
This method has to be used only for Browse purpose,
for instance to retrieve Product properties.
Be careful, it doesn't open any editor (no visualization, no
undo/redo capabilities...)
As soon as you want to modify the V5 document, you have to use
the VB Open method collection.
If this solution is not satisfactory because it opens an
editor for every document, you have to move to C++ and use the CAA methods
CATDocumentServices::Open and CATDocumentServices::SaveAs with the same file
name as the initial one.
Parameters:
iFileName
The name of the file containing the document
Returns:
The retrieved document Example:
The following example reads the Doc document
contained in the FileToOpen file.
FileToOpen = "e:\users\psr\Parts\ThisIsANicePart.CATPart"
Dim Doc As Document
Set Doc = Documents.Read(FileToOpen)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_DraftingPageSetup_25939 ===
InfInterfaces DraftingPageSetup (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
DraftingPageSetup (Object)
Represents the page setup for the drawing documents.
The page setup is the object that stores data which defines how your
documents and images are actually printed on paper.
This data includes namely the paper size, the orientation,
the bottom, top, right, and left margins, the zoom factor, the banner,
the printing quality, the choice of the best orientation, and the choice
to fit either the drawing sheet format or the printer format.
Property Index
ChooseBestOrientation
Activates or deactivates the choice of the best orientation.
FitToPrinterFormat
Fits the format of the print to the printer format.
FitToSheetFormat
Fits the format of the print to the sheet format.
Properties
Property ChooseBestOrientation() As
Activates or deactivates the choice of the best orientation.
Example:
This example requests the best orientation to be chosen for MySheet.
MySheet.DrawingPageSetUp.ChooseBestOrientation = TRUE
Property FitToPrinterFormat() As
Fits the format of the print to the printer format.
Example:
This example turns this calculation on.
MySheet.DrawingPageSetUp.FitToPrinterFormat = TRUE
Property FitToSheetFormat() As
Fits the format of the print to the sheet format.
Example:
This example turns this calculation on.
MySheet.DrawingPageSetUp.FitToSheetFormat = TRUE
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_File_12445 ===
InfInterfaces File (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
File (Object)
Represents the file object.
Role: The file object allows to manipulate files with UNIX and Windows.
Use it instead of the one of Visual Basic to make portable macros.
Its gives access to information about the file
and can open a file as a  object.
Property Index
Size
Returns the size of the file.
Type
Returns the type of the file.
Method Index
OpenAsTextStream
Opens the file and retrieves it as a TextSteam object.
Properties
Property Size() As   (Read Only)
Returns the size of the file.
Example:
This example retrieves in FileSize the size of
the File TestFile.
Dim FileSize As Long
FileSize = TestFile.Size
Property Type() As   (Read Only)
Returns the type of the file. For instance, if the file has a
.txt or .doc extension, its type will be "Text Document".
Example:
This example retrieves in FileType the type of
the File TestFile.
Dim FileType As String
FileSize = TestFile.Size
Methods
Func OpenAsTextStream( iMode) As
Opens the file and retrieves it as a TextSteam object.
Paramater iMode can have the value "ForReading", "ForWriting"
or "ForAppending".
Example:
This example opens the file TestFile for reading and retrieves in the
text stream TextStr.
Dim TextStr As CATIATextSteam
Set TextStr = TestFile.OpenAsTextStream("ForReading")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_FileComponent_20196 ===
InfInterfaces FileComponent (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
FileComponent (Object)
Represents the file object.
Role: The file object allows to manipulate files with UNIX and Windows.
Use it instead of the one of Visual Basic to make portable macros.
Its gives access to information about the file
and can open a file as a  object.
Property Index
ParentFolder
Returns or sets the parent folder of the file.
Path
Returns the full path of the file.
Properties
Property ParentFolder() As
Returns or sets the parent folder of the file.
Example:
This example sets the folder ParentFold as parent of the file TestFile.
This moves the file into ParentFold.
TestFile.ParentFolder
Property Path() As   (Read Only)
Returns the full path of the file.
Example:
This example retrieves in FilePath the path of
the File TestFile.
Dim FilePath As String
FilePath = TestFile.Path
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Files_12905 ===
InfInterfaces Files (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Files (Object)
A collection of all the file objects in a folder.
It lists all the files contained in the folder.
It allows to retrieve  objects.
Method Index
Item
Returns a file using its index or its name from the file collection.
Methods
Func Item( iNumber) As
Returns a file using its index or its name from the file collection.
Parameters:
iIndex
The index or the name of the file to retrieve from
the collection of files.
As a numerics, this index is the rank of the file
in the collection.
The index of the first file in the collection is 1, and
the index of the last file is Count.
As a string, it is the name you assigned to the file using
the
property.
Returns:
The retrieved file Example:
This example retrieves in ThisFile the third file,
and it ThatFile the file named MyFile.
in the TestFiles file collection.
Dim ThisFile As File
Set ThisFile = TestFiles.Item(3)
Dim ThatFile As File
Set ThatFile = TestFiles.Item("MyFile")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_FileSystem_16673 ===
InfInterfaces FileSystem (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
FileSystem (Object)
Represents the file system object.
Role: The file system object allows you to access and manipulate
folders and files.
It can check the existence of, get, create, delete, or copy
folders and files.
See also:
,
Property Index
FileSeparator
Returns the file separator string.
PathSeparator
Returns the path separator string.
TemporaryDirectory
Returns the temporary system directory.
Method Index
ConcatenatePaths
Concatenates two path chunks to make a new path.
CopyFile
Copies a file from one location to another.
CopyFolder
Recursively copies a folder from one location to another.
CreateFile
Creates a file and returns the associated file object.
CreateFolder
Creates a folder and returns the associated folder object.
DeleteFile
Deletes a file.
DeleteFolder
Deletes a folder.
FileExists
Returns whether a given file exists.
FolderExists
Returns whether a given folder exists.
GetFile
Returns a file using its full path.
GetFolder
Returns a folder using its full path.
Properties
Property FileSeparator() As   (Read Only)
Returns the file separator string.
(usually, \\ on Windows and / on UNIX)
Parameters:
oTmpDirectory
The file separator string.
Property PathSeparator() As   (Read Only)
Returns the path separator string.
(usually,; on Windows and : on UNIX)
Parameters:
oTmpDirectory
The path separator string.
Property TemporaryDirectory() As   (Read Only)
Returns the temporary system directory.
(usually, C:\\temp on Windows and /tmp on UNIX)
Parameters:
oTmpDirectory
A folder which corresponds to the temporary system directory.
Methods
Func ConcatenatePaths( iPathChunk1, iPathChunk2) As
Concatenates two path chunks to make a new path.
Either path chunk can be empty. The resulting path
does not have to exist. The method automatically corrects
improper path separators (/ Unix separators used on a Windows platform
are automatically replaced by \\ and vice versa).
Parameters:
iPathChunk1
The first path chunk (for instance "E:\\tmp").
iPathChunk2
The second path chunk (for instance "local\myfile.txt").
oPath
The resulting path (for instance "E:\\tmp\\local\\myfile.txt").
Sub CopyFile( iPathSource, iPathDestination, iOverwrite)
Copies a file from one location to another.
Parameters:
iSourcePath
The full path of the source file.
iDestinationPath
The full destination path where the source file is to be copied.
iOverwrite
Boolean value that is True if an existing file with the same name
can be overwritten; False if it is not, and the copy doesn't take place.
Example:
This example copies the file C:\Tests\File1 to C:\Tests\File2
from the file system object FileSys, except if a file
with the name C:\Tests\File2 already exists.
FileSys.CopyFile("C:\Tests\File1", "C:\Tests\File2", False)
Sub CopyFolder( iSourcePath, iDestinationPath)
Recursively copies a folder from one location to another.
Role: The folder is copied along with its files, and all its
subfolders and their own files.
Parameters:
iSourcePath
The full path of the source folder.
iDestinationPath
The full destination path where the source folder, its files, and its subfolders
are to be copied.
Example:
This example copies the folder "C:\Tests\Fold1" to "C:\Tests\Fold2"
of the file system object FileSys.
FileSys.CopyFolder("C:\Tests\Fold1", "C:\Tests\Fold2")
Func CreateFile( iPath, iOverwrite) As
Creates a file and returns the associated file object.
Parameters:
iPath
The full path where the file is to be created.
iOverwrite
Boolean value that is True if an existing file with the same name
can be overwritten; False if it is not, and the creation doesn't take place.
Returns:
The created file
Example:
This example creates the file C:\Tests\File1 and
retrieves it in the file object FileObj
from the file system object FileSys, except if a file
with the name  C:\Tests\File1 already exists.
Dim FileObj As File
Set FileObj = FileSys.CreateFile("C:\Tests\File1", False)
Func CreateFolder( iPath) As
Creates a folder and returns the associated folder object.
Parameters:
iPath
The full path where the folder is to be created.
Returns:
The created folder object. If the folder
already exists, the method fails.
Example:
This example creates the folder "C:\Tests\Fold1" and
retrieves it in FoldObj from the FileSystem FileSys.
Dim FoldObj As Folder
Set FoldObj = FileSys.CreateFolder("C:\Tests\Fold1")
Sub DeleteFile( iPath)
Deletes a file.
The method fails if the folder doesn't exist.
Parameters:
iPath
The full path of the file to delete.
Example:
This example deletes the file "C:\Tests\File"
from the file system object FileSys.
FileSys.DeleteFile("C:\Tests\File1")
Sub DeleteFolder( iPath)
Deletes a folder.
The method fails if the folder doesn't exist.
Parameters:
iPath
The full path of the folder to delete.
Example:
This example deletes the folder "C:\Tests\Fold1"
from the FileSystem FileSys.
FileSys.DeleteFolder("C:\Tests\Fold1")
Func FileExists( iPath) As
Returns whether a given file exists.
True if the file exists.
Parameters:
iPath
The full path of the file.
Example:
This example retrieves in Exists whether
the file "C:\Tests\File1" exists in the file system object
FileSys.
Dim Exists As Boolean
Exists = FileSys.FileExists("C:\Tests\File1")
Func FolderExists( iPath) As
Returns whether a given folder exists.
True if the folder exists.
Parameters:
iPath
The full path of the folder.
Example:
This example retrieves in Exists whether
the folder "C:\Tests\Fold1" exists in the file system object
FileSys.
Dim Exists As Boolean
Exists=FileSys.FolderExists("C:\Tests\Fold1")
Func GetFile( iPath) As
Returns a file using its full path.
The method fails if the folder doesn't exist.
Parameters:
iPath
The full path of the file to retrieve.
Example:
This example retrieves the file C:\Tests in the FileObj
from the file system object FileSys.
Dim FileObj As File
Set FileObj = FileSys.GetFile("C:\Tests")
Func GetFolder( iPath) As
Returns a folder using its full path.
Parameters:
iPath
The full path of the folder to retrieve.
Returns:
The retrieved folder. If the folder
doesn't exist, the method fails.
Example:
This example retrieves the C:Tests folder in FoldObj
from the file system object FileSys.
Dim FoldObj As Folder
Set FoldObj = FileSys.GetFolder("C:\Tests\")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Folder_13422 ===
InfInterfaces Folder (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Folder (Object)
Represents the folder object.
It allows you to manipulate folders and
gives access to information about them.
Property Index
Files
Returns the file collection of the folder.
SubFolders
Returns the folder collection of the folder.
Properties
Property Files() As   (Read Only)
Returns the file collection of the folder.
Example:
This example retrieves in TestFiles the file collection
of the folder TestFolder.
Dim TestFiles As Files
Set TestFiles = TestFolder.Files
Property SubFolders() As   (Read Only)
Returns the folder collection of the folder.
Example:
This example retrieves in TestSubFolders the folder colection
of the folder TestFolder.
Dim TestSubFolders As CATIAFolders
Set TestSubFolders = TestFolder.SubFolders
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Folders_14112 ===
InfInterfaces Folders (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Folders (Object)
The folders object belongs to a folder.
It lists all the folders contained in the folder.
It allows to retrieve  objects.
Method Index
Item
Returns a folder using its index or its name from the folder collection.
Methods
Func Item( iNumber) As
Returns a folder using its index or its name from the folder collection.
Parameters:
iIndex
The index or the name of the folder to retrieve from
the collection of folders.
As a numerics, this index is the rank of the folder
in the collection.
The index of the first folder in the collection is 1, and
the index of the last folder is Count.
As a string, it is the name you assigned to the folder using
the
property.
Returns:
The retrieved folder Example:
This example retrieves in ThisFolder the third folder,
and it ThatFolder the folder named MyFolder.
in the TestFolders folder collection.
Dim ThisFolder As Folder
Set ThisFolder = TestFolders.Item(3)
Dim ThatFolder As Folder
Set ThatFolder = TestFolders.Item("MyFolder")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_GeneralSessionSettingAtt_40655 ===
InfInterfaces GeneralSessionSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
GeneralSessionSettingAtt (Object)
Setting controller for the General property tab page.
Role: This interface is implemented by a component which
represents the controller of the general settings.
Property Index
AutoSave
Returns the data save parameter.
Conferencing
Returns the conference driver parameter.
DragDrop
Returns the drag & drop parameter.
RefDoc
Returns the referenced documents parameter.
TimeRoll
Returns the data save parameter (in milliseconds).
UIStyle
Returns the user interface style parameter.
Method Index
GetAutoSaveInfo
Retrieves environment informations for the data save parameter.
GetConferencingInfo
Retrieves environment informations for the conference driver parameter.
GetDragDropInfo
Retrieves environment informations for the drag & drop parameter.
GetRefDocInfo
Retrieves environment informations for the referenced documents parameter.
GetUIStyleInfo
Retrieves environment informations for the user interface style parameter.
SetAutoSaveLock
Locks or unlocks the data save parameter.
SetConferencingLock
Locks or unlocks the conference driver parameter.
SetDragDropLock
Locks or unlocks the drag & drop parameter.
SetRefDocLock
Locks or unlocks the referenced documents parameter.
SetUIStyleLock
Locks or unlocks the user interface style parameter.
Properties
Property AutoSave() As
Returns the data save parameter.
Property Conferencing() As
Returns the conference driver parameter.
Property DragDrop() As
Returns the drag & drop parameter.
Property RefDoc() As
Returns the referenced documents parameter.
Property TimeRoll() As
Returns the data save parameter (in milliseconds).
Property UIStyle() As
Returns the user interface style parameter.
Methods
Func GetAutoSaveInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the data save parameter.
Role:Retrieves the state of the data save parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetConferencingInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the conference driver parameter.
Role:Retrieves the state of the conference driver parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetDragDropInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the drag & drop parameter.
Role:Retrieves the state of the drag & drop parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetRefDocInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the referenced documents parameter.
Role:Retrieves the state of the referenced documents parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetUIStyleInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the user interface style parameter.
Role:Retrieves the state of the user interface style parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub SetAutoSaveLock( iLocked)
Locks or unlocks the data save parameter.
Role:Locks or unlocks the data save 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.
Sub SetConferencingLock( iLocked)
Locks or unlocks the conference driver parameter.
Role:Locks or unlocks the conference driver 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.
Sub SetDragDropLock( iLocked)
Locks or unlocks the drag & drop parameter.
Role:Locks or unlocks the drag & drop 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.
Sub SetRefDocLock( iLocked)
Locks or unlocks the referenced documents parameter.
Role:Locks or unlocks the referenced documents 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.
Sub SetUIStyleLock( iLocked)
Locks or unlocks the user interface style parameter.
Role:Locks or unlocks the user interface style 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.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_LightSource_17621 ===
InfInterfaces LightSource (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
LightSource (Object)
Represents the light source.
The light source is the object that stores lighting data used by a
viewer to display a scene where a document is presented.
Two kinds of light sources are available: an infinite light source
and a neon lighting system simulating a set of parallel neon tubes.
Method Index
GetDirection
Returns the lighting direction as an array of 3 variants.
PutDirection
Defines the lighting direction as an array of 3 variants.
Methods
Sub GetDirection( oDirection)
Returns the lighting direction as an array of 3 variants.
This value is available with an infinite light source only.
Example:
This example gets the lighting direction of the LightSource
light source to the direction with components (5,8,-2).
Dim direction(2)
LightSource.GetDirection direction
Sub PutDirection( oDirection)
Defines the lighting direction as an array of 3 variants.
This value can be set with an infinite light source only.
Example:
This example defines the lighting direction of the LightSource
light source to the direction with components (5,8,-2).
LightSource.PutDirection Array(5,8,-2)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_LightSources_18886 ===
InfInterfaces LightSources (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
LightSources (Object)
A collection of all the LightSource objects.
This collection is currently managed by a  object.
Method Index
Add
Adds a new light source to the LightSources collection.
Item
Returns a light source from its index in the LightSources collection.
Remove
Removes a light source from the LightSources collection.
Methods
Func Add() As
Adds a new light source to the LightSources collection.
Example:
The following adds a light source to the collection
attached to the active viewer.
This viewer must be a @see Viewer3D object.
Dim MyViewer As Viewer
Set MyViewer = CATIA.ActiveWindow.ActiveViewer
Dim MyLightSource As LightSource
Set MyLightSource = MyViewer.LightSources.Add
Func Item( iIndex) As
Returns a light source from its index in the LightSources collection.
Parameters:
iIndex
The index of the light source to retrieve in the collection of
light sources.
Compared with other collections, you cannot use the name of the
light source as argument.
Returns:
The retrieved light source
Example:
The following example returns in MyLightSource the sixth
light source in the collection.
Dim MyLightSource As LightSource
Set MyLightSource = LightSources.Item(6)
Sub Remove( iIndex)
Removes a light source from the LightSources collection.
Parameters:
iIndex
The index of the light source to remove.
Compared with other collections, you cannot use the name of the
light source as argument.
Example:
The following example removes the second light source
in the collection attached to the active viewer.
This viewer must be a
object.
Dim MyViewer As Viewer
Set MyViewer = CATIA.ActiveWindow.ActiveViewer
MyViewer.LightSources.Remove(2)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_MacrosSettingAtt_24359 ===
InfInterfaces MacrosSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
MacrosSettingAtt (Object)
Setting controller for the Macros tab page.
Method Index
GetDefaultMacroLibraries
Returns the list of default macro libraries.
GetDefaultMacroLibrariesInfo
Retrieves environment informations for the default macro libraries setting.
GetExternalReferences
Returns the list of external references.
GetExternalReferencesInfo
Retrieves environment informations for the external references setting.
GetLanguageEditor
Returns the editor path for the specified language.
GetLanguageEditorInfo
Retrieves environment informations for the language editors setting.
SetDefaultMacroLibraries
Sets the list of default macro libraries.
SetDefaultMacroLibrariesLock
Locks or unlocks the default macro libraries setting.
SetExternalReferences
Sets the list of external references.
SetExternalReferencesLock
Locks or unlocks the external references setting.
SetLanguageEditor
Sets the editor path for the specified language.
SetLanguageEditorLock
Locks or unlocks the language editors setting.
Methods
Func GetDefaultMacroLibraries() As
Returns the list of default macro libraries.
Func GetDefaultMacroLibrariesInfo( AdminLevel, oLocked) As
Retrieves environment informations for the default macro libraries setting.
Role:Retrieves the state of the parameter default macro libraries setting
in the current environment.
Parameters:
AdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetExternalReferences() As
Returns the list of external references.
Func GetExternalReferencesInfo( AdminLevel, oLocked) As
Retrieves environment informations for the external references setting.
Role:Retrieves the state of the parameter external references setting
in the current environment.
Parameters:
AdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetLanguageEditor( iLanguage) As
Returns the editor path for the specified language.
Func GetLanguageEditorInfo( AdminLevel, oLocked) As
Retrieves environment informations for the language editors setting.
Role:Retrieves the state of the parameter language editors setting
in the current environment.
Parameters:
AdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub SetDefaultMacroLibraries( iLibraries)
Sets the list of default macro libraries.
Sub SetDefaultMacroLibrariesLock( iLocked)
Locks or unlocks the default macro libraries setting.
Role:Locks or unlocks the default macro libraries setting 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.
Sub SetExternalReferences( iReferences)
Sets the list of external references.
Sub SetExternalReferencesLock( iLocked)
Locks or unlocks the external references setting.
Role:Locks or unlocks the external references setting 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.
Sub SetLanguageEditor( iLanguage, iEditorPath)
Sets the editor path for the specified language.
Sub SetLanguageEditorLock( iLocked)
Locks or unlocks the language editors setting.
Role:Locks or unlocks the language editors setting 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.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Move_12471 ===
InfInterfaces Move (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Move (Object)
Represents an object associated with any kind of objects which
retrieves the corresponding movable object.
An object can be moved only if it is independent from other objects.
For example, a pad can be moved, and is as such a movable object,
while an edge cannot be moved individually.
It should be moved with all the objects making up the pad to which
it belongs as a whole.
In this case, the underlying edge's movable object is the pad.
Property Index
MovableObject
Returns the movable object associated with the used object.
Method Index
Apply
Applies a move transformation to a movable object.
Properties
Property MovableObject() As   (Read Only)
Returns the movable object associated with the used object.
Example:
This example retrieves the myMovableObject from
Move object associated with MyObject.
Dim myMovableObject As Move
Set myMovableObject = MyObject.Move.MovableObject
Methods
Sub Apply( iTransformationArray)
Applies a move transformation to a movable object.
Parameters:
TransformationArray
The linear transformation array initialized successively by the
four columns of the transformation matrix.
The first nine components represent the rotation matrix.
The last three components represent the translation vector.
Example:
This example applies the transformation (45 degrees-rotation around
the x axis and a translation) stored in TransformationArray
to the Move object associated with myMovableObject:
Dim TransformationArray( 11 )
'Rotation( 45 degrees around the x axis) components
TransformationArray( 0 )  = 1.000
TransformationArray( 1 )  = 0
TransformationArray( 2 )  = 0
TransformationArray( 3 )  = 0
TransformationArray( 4 )  = 0.707
TransformationArray( 5 )  = 0.707
TransformationArray( 6 )  = 0
TransformationArray( 7 )  = -0.707
TransformationArray( 8 )  = 0.707
'Translation Vector (10,20,30)
TransformationArray( 9 )  = 10.000
TransformationArray( 10 ) = 20.000
TransformationArray( 11 ) = 30.000
MyMovableObject.Move.Apply TransformationArray
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_PageSetup_15675 ===
InfInterfaces PageSetup (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
PageSetup (Object)
Represents the page setup.
The page setup is the object that stores data which defines how your
documents and images are actually printed on paper.
This data includes namely the paper size, the orientation,
the bottom, top, right, and left margins, the zoom factor, the banner,
and the printing quality.
Property Index
Banner
Returns or sets the banner text.
BannerPosition
Returns or sets the banner position.
BannerSize
Returns or sets Banner Size.
Bottom
Returns or sets the lower left corner location with respect to the bottom
of the sheet of paper.
BottomMargin
Returns or sets the bottom margin.
Color
Returns or sets the color mode to use when printing.
Dpi
Returns or sets the printing dpi.
Gamma
Returns or sets Gamma factor for print.
Left
Returns or sets the lower left corner location with respect to the left
of the sheet of paper.
LeftMargin
Returns or sets the left margin.
LineCap
Returns or sets Line cap for print.
LineTypeOverlappingCheck
Returns or sets text Line type overlap check option for print.
LineTypeSpecification
Returns or sets Line type specification for print.
LineWidthSpecification
Returns or sets Line width specification for print.
Logo
Returns or sets the file containing the logo image.
LogoVisibility
Returns or sets LogoVisibility option for print.
MaximumSize
Returns or sets whether the document or the image should be printed
at the maximum size with respect to the page size and margins.
Orientation
Returns or sets the paper orientation.
PaperHeight
Returns or sets the paper height.
PaperSize
Returns or sets the paper size.
PaperWidth
Returns or sets the paper width.
PrintRenderingMode
Returns or sets the printing rendering mode.
Quality
Returns or sets the printing quality.
RightMargin
Returns or sets the right margin.
Rotation
Returns or sets the rotation of the document or the image  to print.
Scaling1To1
Returns or sets whether the document or the image should be printed
with a zoom factor equals to 1 and the image to print
lower left corner on the paper lower corner.
TextBlanking
Returns or sets the text blanking option in print
Text will be printed in blanking rectangle
Default value is FALSE
Example:
This example sets the text blanking option
for the SetupForMyPrint page setup.
TextScaling
Returns or sets text scaling option for print.
TopMargin
Returns or sets the top margin.
Use3DAccuracy
Returns or sets Use3DAccuracy option for print.
UseImageSize
Returns or sets the paper size to the image size.
WhiteVectorsInBlack
Returns or sets the white vectors in black option.
Zoom
Returns or sets the zoom factor to use when printing.
Properties
Property Banner() As
Returns or sets the banner text.
The banner text is added to the print and can include variables,
such as the user who prints, the date and time of printing.
Available variables are:
$USER           The user name
$HOST           The workstation name
$SCALE          The print scale
$TIME           The print time
$DATE           The print date
$DAY            The print day
$MONTH          The print month
$YEAR           The print year
The default banner is:
Printed by $USER on $DATE $TIME
Example:
This example sets the banner text to the following:
Printed by $USER at scale $SCALE on $MONTH/$DAY/$YEAR
for the SetupForMyPrint page setup.
SetupForMyPrint.Banner = "Printed by $USER at scale $SCALE on $MONTH/$DAY/$YEAR"
Property BannerPosition() As
Returns or sets the banner position.
The banner can be located on the top, bottom, left, or right side
of the page. catBannerPositionNone removes the banner.
Example:
This example sets the banner on the top side of the page
for the SetupForMyPrint page setup.
SetupForMyPrint.BannerPosition = CatBannerPositionTop
Property BannerSize() As
Returns or sets Banner Size.
Banner size could range from 0.1 mm to 10.0 mm
Default value is 2.4 mm
Example:
This example sets banner size
for the SetupForMyPrint page setup.
SetupForMyPrint.BannerSize = 1.1
Property Bottom() As
Returns or sets the lower left corner location with respect to the bottom
of the sheet of paper.
This is the distance of the document or the image to print
lower left corner to the paper lower left corner.
Example:
This example sets the location of the lower left corner of the document
or the image to print at 40 mm from the paper lower left corner
for the SetupForMyPrint page setup.
SetupForMyPrint.Bottom = 40
Property BottomMargin() As
Returns or sets the bottom margin.
The bottom margin is a strip in which nothing is printed, located
at the bottom of the page, which height is expressed in mm.
Example:
This example sets the bottom margin for the SetupForMyPrint
page setup to 10 mm.
SetupForMyPrint.BottomMargin = 10
Property Color() As
Returns or sets the color mode to use when printing.
Example:
This example sets the color mode to GreyScale
for the SetupForMyPrint page setup.
SetupForMyPrint.Color = catColorGreyScale
Property Dpi() As
Returns or sets the printing dpi.
Example:
This example sets the printing dpi
for the SetupForMyPrint page setup.
SetupForMyPrint.Dpi = 150.
Property Gamma() As
Returns or sets Gamma factor for print.
Gamma value could range from 0.1 to 5.0
Default value is 1.0
Example:
This example sets Gamma factor
for the SetupForMyPrint page setup.
SetupForMyPrint.Gamma = 1.2
Property Left() As
Returns or sets the lower left corner location with respect to the left
of the sheet of paper.
This is the distance of the document or the image to print
lower left corner to the paper lower left corner.
Example:
This example sets the location of the lower left corner of the document
or the image to print at 25 mm from the paper lower left corner
for the SetupForMyPrint page setup.
SetupForMyPrint.Left = 25
Property LeftMargin() As
Returns or sets the left margin.
The left margin is a strip in which nothing is printed, located
at the left of the page, which width is expressed in mm.
Example:
This example sets the left margin for the SetupForMyPrint
page setup to 10 mm.
SetupForMyPrint.LeftMargin = 10
Property LineCap() As
Returns or sets Line cap for print.
Refer to
Default value is catPrintFlat
Example:
This example sets Line cap
for the SetupForMyPrint page setup.
SetupForMyPrint.LineCap = catPrintFlat
Property LineTypeOverlappingCheck() As
Returns or sets text Line type overlap check option for print.
Default value is FALSE
Example:
This example sets Line type overlapping check option
for the SetupForMyPrint page setup.
SetupForMyPrint.LineTypeOverlappingCheck = True
Property LineTypeSpecification() As
Returns or sets Line type specification for print.
Refer to
Default value is catPrintAbsolute
Example:
This example sets Line type specification
for the SetupForMyPrint page setup.
SetupForMyPrint.LineTypeSpecification = catPrintAbsolute
Property LineWidthSpecification() As
Returns or sets Line width specification for print.
Refer to
Default value is catPrintAbsolute
Example:
This example sets Line width specification
for the SetupForMyPrint page setup.
SetupForMyPrint.LineWidthSpecification = catPrintAbsolute
Property Logo() As
Returns or sets the file containing the logo image.
The logo is printed with the banner.
Example:
This example sets the logo file to the following file:
e:\users\psr\Images\Logo.tif
for the SetupForMyPrint page setup.
SetupForMyPrint.Logo = "e:\users\psr\Images\Logo.tif"
Property LogoVisibility() As
Returns or sets LogoVisibility option for print.
Default value is FALSE
Example:
This example sets LogoVisibility option
for the SetupForMyPrint page setup.
SetupForMyPrint.LogoVisibility = True
Property MaximumSize() As
Returns or sets whether the document or the image should be printed
at the maximum size with respect to the page size and margins.
True if the document or the image is printed with the maximum
size.
This overrides the location properties, that is Left and Bottom,
and the Zoom property values.
Example:
This example requests to print the document or the image with the
SetupForMyPrint page setup at maximum size.
SetupForMyPrint.MaximumSize = True
Property Orientation() As
Returns or sets the paper orientation.
Example:
This example sets the paper orientation for the SetupForMyPrint
page setup to catPaperLandscape.
SetupForMyPrint.Orientation = catPaperLandscape
Property PaperHeight() As
Returns or sets the paper height.
Example:
This example sets the page height for the SetupForMyPrint
page setup to 297 mm..
SetupForMyPrint.PaperHeight = 297
Property PaperSize() As
Returns or sets the paper size.
Example:
This example sets the page size for the SetupForMyPrint
page setup to catPaperA4.
SetupForMyPrint.PaperSize = catPaperA4
Property PaperWidth() As
Returns or sets the paper width.
Example:
This example sets the page width for the SetupForMyPrint
page setup to 210 mm..
SetupForMyPrint.PaperWidth = 210
Property PrintRenderingMode() As
Returns or sets the printing rendering mode.
Example:
This example sets the printing rendering mode
for the SetupForMyPrint page setup.
SetupForMyPrint.PrintRenderingMode = CatPrintRenderingModeDefault
Property Quality() As
Returns or sets the printing quality.
Refer to
Example:
This example sets the printing quality to draft
for the SetupForMyPrint page setup.
SetupForMyPrint.Quality = catPrintQualityDraft
Property RightMargin() As
Returns or sets the right margin.
The right  margin is a strip in which nothing is printed, located
at the right of the page, which width is expressed in mm.
Example:
This example sets the right margin for the SetupForMyPrint
page setup to 12 mm.
SetupForMyPrint.RightMargin = 12
Property Rotation() As
Returns or sets the rotation of the document or the image  to print.
Rotations angles can be 0, 90, 180, and 270 degrees counted
clockwise.
Example:
This example sets the rotation to 90 degrees clockwise
for the SetupForMyPrint page setup.
SetupForMyPrint.Rotation = catImageRotation90
Property Scaling1To1() As
Returns or sets whether the document or the image should be printed
with a zoom factor equals to 1 and the image to print
lower left corner on the paper lower corner.
True if the document or the image is printed with the zoom
factor equals to 1 and the image to print
lower left corner on the paper lower corner.
This overrides the location properties, that is Left and Bottom,
and the Zoom property values.
Example:
This example requests to print the document or the image with the
SetupForMyPrint page setup.
SetupForMyPrint.Scaling1To1 = True
Property TextBlanking() As
Returns or sets the text blanking option in print
Text will be printed in blanking rectangle
Default value is FALSE
Example:
This example sets the text blanking option
for the SetupForMyPrint page setup.
SetupForMyPrint.TextBlanking = True
Property TextScaling() As
Returns or sets text scaling option for print.
Default value is TRUE
Example:
This example sets text scaling option
for the SetupForMyPrint page setup.
SetupForMyPrint.TextScaling = True
Property TopMargin() As
Returns or sets the top margin.
The top margin is a strip in which nothing is printed, located
at the top of the page, which height is expressed in mm.
Example:
This example sets the top margin for the SetupForMyPrint
page setup to 15 mm.
SetupForMyPrint.TopMargin = 15
Property Use3DAccuracy() As
Returns or sets Use3DAccuracy option for print.
Default value is FALSE
Example:
This example sets Use3DAccuracy option
for the SetupForMyPrint page setup.
SetupForMyPrint.Use3DAccuracy = True
Property UseImageSize() As
Returns or sets the paper size to the image size.
Example:
This example sets the paper size to image size
for the SetupForMyPrint page setup.
SetupForMyPrint.UseImageSize = True
Property WhiteVectorsInBlack() As
Returns or sets the white vectors in black option.
white vectors will be printed in black if set to True
Default value is TRUE
Example:
This example sets the Print White Vectors In Black option
for the SetupForMyPrint page setup.
SetupForMyPrint.WhiteVectorsInBlack = True
Property Zoom() As
Returns or sets the zoom factor to use when printing.
Example:
This example sets the zoom factor to 1.5
for the SetupForMyPrint page setup.
SetupForMyPrint.Zoom = 1.5
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Position_14902 ===
InfInterfaces Position (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Position (Object)
Represents the position object.
The position object is the 3D-axis system associated with an object.
Method Index
GetComponents
Returns the components of an object's position.
SetComponents
Sets the components of an object's position.
Methods
Sub GetComponents( oAxisComponentsArray)
Returns the components of an object's position.
This returns the 3D-axis system associated with the object.
Parameters:
oAxisComponentsArray
The array used to store the twelve components retrieved from
the objet's position.
The first nine represent succcessively the components of the x-axis,
y-axis, and z-axis.
The last three represent the coordinates of the origin point.
Example:
This example retrieves in oAxisComponentsArray
the 3D-axis system components from
the Position object associated with MyObject:
Dim oAxisComponentsArray ( 11 )
MyObject.Position.GetComponents oAxisComponentsArray
Sub SetComponents( iAxisComponentsArray)
Sets the components of an object's position.
This sets the 3D-axis system associated with the object.
Parameters:
iAxisComponentsArray
The array initialized with the components to set to the
object's position.
The first nine represent succcessively the components of the x-axis,
y-axis, and z-axis.
The last three represent the coordinates of the origin point.
Example:
This example sets the 3D-axis system components stored in
iAxisComponentsArray to
the Position object associated with MyObject:
Dim iAxisComponentsArray( 11 )
' x axis components
iAxisComponentsArray( 0 )  = 1.000
iAxisComponentsArray( 1 )  = 0
iAxisComponentsArray( 2 )  = 0.707
' y axis components
iAxisComponentsArray( 3 )  = 0
iAxisComponentsArray( 4 )  = 0
iAxisComponentsArray( 5 )  = 0.707
' z axis components
iAxisComponentsArray( 6 )  = 0
iAxisComponentsArray( 7 )  = -0.707
iAxisComponentsArray( 8 )  = 0.707
' origin point coordinates
iAxisComponentsArray( 9 )  = 1.000
iAxisComponentsArray( 10 ) = 2.000
iAxisComponentsArray( 11 ) = 3.000
MyObject.Position.SetComponents iAxisComponentsArray
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Printer_14128 ===
InfInterfaces Printer (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Printer (Object)
Represents a printer handled by the printing subsystem.
This object is read only and gives access to some properties of the printer.
Property Index
DeviceName
Returns the printer device name.
Orientation
Returns or sets the default paper orientation.
PaperHeight
Returns the default paper height.
PaperSize
Returns the default paper size.
PaperWidth
Returns the default paper width.
Properties
Property DeviceName() As   (Read Only)
Returns the printer device name.
Example:
This example displays the device name of the myPrinter printer.
MsgBox myPrinter.DeviceName
Property Orientation() As   (Read Only)
Returns or sets the default paper orientation.
Example:
This example retrieves in DefaultPaperOrientation the default paper orientation
of the myPrinter printer.
Dim DefaultPaperOrientation As CatPaperOrientation
DefaultPaperOrientation = myPrinter.Orientation
Property PaperHeight() As   (Read Only)
Returns the default paper height.
Example:
This example retrieves in Height the default paper height
of the myPrinter printer.
Dim Height
Height = myPrinter.PaperHeight
Property PaperSize() As   (Read Only)
Returns the default paper size.
Example:
This example retrieves in DefaultPaperSize the default paper size
of the myPrinter printer.
Dim DefaultPaperSize As CatPaperSize
DefaultPaperSize = myPrinter.PaperSize
Property PaperWidth() As   (Read Only)
Returns the default paper width.
Example:
This example retrieves in Witdh the default paper width
of the myPrinter printer.
Dim Width As float
Width = myPrinter.PaperWidth
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Printers_14933 ===
InfInterfaces Printers (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Printers (Object)
A collection of all the Printer objects managed by the application.
Method Index
Item
Returns a printer using its index or its device name from the Printers collection.
Methods
Func Item( iIndex) As
Returns a printer using its index or its device name from the Printers collection.
Parameters:
iIndex
The index or the name of the printer to retrieve from
the collection of printers.
As a numerics, this index is the rank of the printer
in the collection.
The index of the first printer in the collection is 1, and
the index of the last printer is Count.
As a string, it is the DeviceName of the printer.
Returns:
The retrieved printer
Example:
This example returns in ThisPrinter the third printer
in the collection, and in ThatPrinter the printer named
LaserPrinter.
Dim ThisPrinter As Printer
Set ThisPrinter = CATIA.Printers.Item(3)
Dim ThatPrinter As Printer
Set ThatPrinter = CATIA.Printers.Item("LaserPrinter")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_PrintersSettingAtt_27877 ===
InfInterfaces PrintersSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
PrintersSettingAtt (Object)
Represents a setting controller for the printer settings.
Role: This interface is implemented by a component which
represents the controller of the printer settings.
Method Index
AddPrinterDirectory
Add a printer file directory to printer directories list and define its state.
AddPrinterGroup
Add a printer group and define the printers included in this group.
GetDriverConfigurationPath
Returns the driver configuration file.
GetDriverConfigurationPathInfo
Retrieves environment informations for the driver configuration file.
GetNewPrinterDirectory
Returns the directory where new printers will be added.
GetNewPrinterDirectoryInfo
Retrieves environment informations for the directory where printers will be added.
GetPrinterArrayForGroup
Returns the definition of the printer group.
GetPrinterDirectories
Returns the directories of printer files.
GetPrinterDirectoriesInfo
Retrieves environment informations for the directories of printer files and their states.
GetPrinterDirectoryState
Returns the state of the directory of printer files.
GetPrinterGroups
Returns the printer groups.
GetPrinterGroupsInfo
Retrieves environment informations for the definition of each printer group.
ModifyPrinterArrayForGroup
Modify a printer group: redefine the array of printers included in this group.
ModifyPrinterDirectoryState
Modify a printer file directory state.
RemoveAllPrinterDirectories
Remove all the directories including printer files.
RemoveAllPrinterGroups
Remove all the groups of printers.
RemovePrinterDirectory
Remove a directory of printer files from the directories list.
RemovePrinterGroup
Remove a group of printers.
SetDriverConfigurationPath
Sets the driver configuration file.
SetDriverConfigurationPathLock
Locks or unlocks the driver configuration file.
SetNewPrinterDirectory
Sets the directory where new printers will be added.
SetNewPrinterDirectoryLock
Locks or unlocks the directory where printers will be added.
SetPrinterDirectoriesLock
Locks or unlocks the directories of printer files and their states.
SetPrinterGroupsLock
Locks or unlocks the definition of each printer group.
Methods
Sub AddPrinterDirectory( iPrinterDir, iPrinterDirState)
Add a printer file directory to printer directories list and define its state.
Parameters:
iPrinterDir
directory where some 3DPLM printers are defined.
The printers defined in this directory will be available for each user.
iPrinterDirState
printer directory state.
Each directory can be protected to prevent user access to the printers it contains.
The state could be protect or free.
If the state is CatPrinterDirProtect, the parameters of each printer included in the directory
cannot be changed.
If the state is CatPrinterDirFree, the parameters of each printer included in the directory
can be changed, and the printers can be removed.
Legal values:
CatPrinterDirProtect : the printers included in the directory are protected.
CatPrinterDirFree : the printers included in the directory are free.
Sub AddPrinterGroup( iPrinterGroupName, iPrinterNames)
Add a printer group and define the printers included in this group.
Parameters:
iPrinterGroupName
printer group name
iPrinterNames
array of printers included in the group.
Sub GetDriverConfigurationPath( oDriverCfgPath)
Returns the driver configuration file.
Parameters:
oDriverCfgPath
path of the driver configuration file
Func GetDriverConfigurationPathInfo( oAdminLevel, oLocked) As
Retrieves environment informations for the driver configuration file.
Role: Retrieves the state of the driver configuration file
in the current environment.
Parameters:
oAdminLevel
If the parameter is locked, oAdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, oAdminLevel gives the administration
level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetNewPrinterDirectory( oNewPrinterDir)
Returns the directory where new printers will be added.
Parameters:
oNewPrinterDir
directory to add new printers
Role: Each new printer created by an user is added in this directory.
Func GetNewPrinterDirectoryInfo( oAdminLevel, oLocked) As
Retrieves environment informations for the directory where printers will be added.
Role: Retrieves the state of the directory where printers will be added
in the current environment.
Parameters:
oAdminLevel
If the parameter is locked, oAdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, oAdminLevel gives the administration
level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetPrinterArrayForGroup( iPrinterGroupName) As
Returns the definition of the printer group.
Parameters:
iPrinterGroupName
printer group name
Returns:
array of printers included in the group.
Func GetPrinterDirectories() As
Returns the directories of printer files.
Returns:
array of directories where 3DPLM printers are defined.
Func GetPrinterDirectoriesInfo( oAdminLevel, oLocked) As
Retrieves environment informations for the directories of printer files and their states.
Role: Retrieves the state of the directories of printer files and their states
in the current environment.
Parameters:
oAdminLevel
If the parameter is locked, oAdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, oAdminLevel gives the administration
level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetPrinterDirectoryState( iPrinterDir) As
Returns the state of the directory of printer files.
Parameters:
iPrinterDir
directory where some 3DPLM printers are defined.
Returns:
printer directory state.
Each directory can be protected to prevent user access to the printers it contains.
The state could be protect or free.
If the state is CatPrinterDirProtect, the parameters of each printer included in the directory
cannot be changed.
If the state is CatPrinterDirFree, the parameters of each printer included in the directory
can be changed, and the printers can be removed.
Legal values:
CatPrinterDirProtect : the printers included in the directory are protected.
CatPrinterDirFree : the printers included in the directory are free.
Func GetPrinterGroups() As
Returns the printer groups.
Returns:
array of printer group names
Func GetPrinterGroupsInfo( oAdminLevel, oLocked) As
Retrieves environment informations for the definition of each printer group.
Role: Retrieves the state of the definition of each printer group
in the current environment.
Parameters:
oAdminLevel
If the parameter is locked, oAdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, oAdminLevel gives the administration
level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub ModifyPrinterArrayForGroup( iPrinterGroupName, iPrinterNames)
Modify a printer group: redefine the array of printers included in this group.
Parameters:
iPrinterGroupName
printer group name
iPrinterNames
array of printers included in the group.
Sub ModifyPrinterDirectoryState( iPrinterDir, iPrinterDirState)
Modify a printer file directory state.
Parameters:
iPrinterDir
directory where some 3DPLM printers are defined.
iPrinterDirState
printer directory state.
Each directory can be protected to prevent user access to the printers it contains.
The state could be protect or free.
If the state is CatPrinterDirProtect, the parameters of each printer included in the directory
cannot be changed.
If the state is CatPrinterDirFree, the parameters of each printer included in the directory
can be changed, and the printers can be removed.
Legal values:
CatPrinterDirProtect : the printers included in the directory are protected.
CatPrinterDirFree : the printers included in the directory are free.
Sub RemoveAllPrinterDirectories()
Remove all the directories including printer files.
Sub RemoveAllPrinterGroups()
Remove all the groups of printers.
Sub RemovePrinterDirectory( iPrinterDir)
Remove a directory of printer files from the directories list.
Parameters:
iPrinterDir
directory where some 3DPLM printers are defined.
Sub RemovePrinterGroup( iPrinterGroupName)
Remove a group of printers.
Parameters:
iPrinterGroupName
name of the group to remove.
Sub SetDriverConfigurationPath( iDriverCfgPath)
Sets the driver configuration file.
Parameters:
iDriverCfgPath
path of the driver configuration file
Sub SetDriverConfigurationPathLock( iLock)
Locks or unlocks the driver configuration file.
Role: Locks or unlocks the driver configuration file 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.
Sub SetNewPrinterDirectory( iNewPrinterDir)
Sets the directory where new printers will be added.
Parameters:
iNewPrinterDir
directory to add new printers
Role: Each new printer created by an user is added in this directory.
Sub SetNewPrinterDirectoryLock( iLock)
Locks or unlocks the directory where printers will be added.
Role: Locks or unlocks the directory where printers will be added 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.
Sub SetPrinterDirectoriesLock( iLock)
Locks or unlocks the directories of printer files and their states.
Role: Locks or unlocks the directories of printer files and their states 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.
Sub SetPrinterGroupsLock( iLock)
Locks or unlocks the definition of each printer group.
Role: Locks or unlocks the definition of each printer group 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.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Reference_15551 ===
InfInterfaces Reference (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Reference (Object)
Represents an object pointing to another object.
This other object can be either a wireframe  object such as a plane or a line, or a boundary
representation object such as a face, a vertex or an edge.
It may be, in particular, a
object. References are created using appropriate methods for parts.
They are then passed to an object to enable associativity with the
referenced object.
Property Index
DisplayName
Returns the name of the referenced object.
Method Index
ComposeWith
Composes a reference with another reference thus creating a new
composite reference.
Properties
Property DisplayName() As   (Read Only)
Returns the name of the referenced object.
The name of the referenced object is either the name displayed
in the specification tree for a
object or a character string defining the reference for a boundary object.
Example:
The following example returns in StrName the displayable
name of reference FirstRef:
StrName = FirstRef.DisplayName
Methods
Func ComposeWith( iReference) As
Composes a reference with another reference thus creating a new
composite reference.
Parameters:
iReference
The reference to be composed with the current reference.
Example:
The following example returns in CompositeRef
the reference resulting
from the composition of the FirstRef
and SecondRef references.
Dim CompositeRef As Reference
Set CompositeRef = FirstRef.ComposeWith(SecondRef)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_References_16586 ===
InfInterfaces References (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
References (Object)
A collection of all the references aggregated in an object.
See also:
Method Index
Item
Returns a reference using its index or its name from the References
collection.
Methods
Func Item( iIndex) As
Returns a reference using its index or its name from the References
collection.
Parameters:
iIndex
The index or the name of the reference to retrieve from
the collection of references.
As a numerics, this index is the rank of the reference
in the collection.
The index of the first reference in the collection is 1, and
the index of the last reference is Count.
As a string, it is the name you assigned to the reference using
the
property.
Returns:
The retrieved reference
Example:
This example retrieves the last item in the RefList
reference collection by means of the Count property.
Dim LastRef As Reference
Set LastRef = RefList.Item(RefList.Count)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_SearchSettingAtt_24256 ===
InfInterfaces SearchSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
SearchSettingAtt (Object)
Represents the setting controller for the Search property tab page.
Role: The setting controller is the object that enables to
get and set setting parameters.
Property Index
DeepSearchActivation
Returns or sets the Deep Search Activation attribute.
DefaultPowerInputContextPriority
Returns or sets the Default Power Input Context Priority attribute.
DefaultPowerInputContextScope
Returns or sets the Default Power Input Context Scope attribute.
DefaultPowerInputPrefix
Returns or sets the Default Power Input Prefix attribute.
MaxDisplayedResults
Returns or sets the Max Displayed Results attribute.
MaxPreHighlightedElements
Returns or sets the Max Pre-Highlighted Elements attribute.
Method Index
GetDeepSearchActivationInfo
Retrieves information about the Deep Search Activation setting parameter.
GetDefaultPowerInputContextPriorityInfo
Retrieves information about the Default Power Input Context Priority setting parameter.
GetDefaultPowerInputContextScopeInfo
Retrieves information about the Default Power Input Context Scope setting parameter.
GetDefaultPowerInputPrefixInfo
Retrieves information about the Default Power Input Prefix setting parameter.
GetMaxDisplayedResultsInfo
Retrieves information about the Max Displayed Results setting parameter.
GetMaxPreHighlightedElementsInfo
Retrieves information about the Max Displayed Results setting parameter.
SetDeepSearchActivationLock
Locks or unlocks the Deep Search Activation setting parameter.
SetDefaultPowerInputContextPriorityLock
Locks or unlocks the Default Power Input Context Priority setting parameter.
SetDefaultPowerInputContextScopeLock
Locks or unlocks the Default Power Input Context Scope setting parameter.
SetDefaultPowerInputPrefixLock
Locks or unlocks the Default Power Input Prefix setting parameter.
SetMaxDisplayedResultsLock
Locks or unlocks the Max Displayed Results setting parameter.
SetMaxPreHighlightedElementsLock
Locks or unlocks the Max Displayed Results setting parameter.
Properties
Property DeepSearchActivation() As
Returns or sets the Deep Search Activation attribute.
Role: The Deep Search Activation attribute manages the Deep Search option
available in the Search dialog box used to determine whether documents in visualization
mode must be transiently loaded during a search query
Property DefaultPowerInputContextPriority() As
Returns or sets the Default Power Input Context Priority attribute.
Role: The Default Power Input Context Priority attribute manages whether the default
context scope must override the context scope stored in a favorite query
Property DefaultPowerInputContextScope() As
Returns or sets the Default Power Input Context Scope attribute.
Role: The Default Power Input Context Scope attribute manages the default context scope
to be used when none is typed in the Power Input field
Property DefaultPowerInputPrefix() As
Returns or sets the Default Power Input Prefix attribute.
Role: The Default Power Input Prefix attribute manages the default prefix
to be used when none is typed in the Power Input field
Property MaxDisplayedResults() As
Returns or sets the Max Displayed Results attribute.
Role: The Max Displayed Results attribute indicates the maximum number of elements
that can be displayed in the Search results page. Displaying too many lines can stick more
or less the results list so it is recommended to limit this number.
Property MaxPreHighlightedElements() As
Returns or sets the Max Pre-Highlighted Elements attribute.
Role: The Max Pre-Highlighted Elements attribute indicates the maximum number of elements
that can be displayed in the Search results page. Displaying too many elements can stick the session
so it is strongly recommended to limit this number.
Methods
Func GetDeepSearchActivationInfo( oAdminLevel, oLocked) As
Retrieves information about the Deep Search Activation setting parameter.
Refer to
for a detailed description.
Func GetDefaultPowerInputContextPriorityInfo( oAdminLevel, oLocked) As
Retrieves information about the Default Power Input Context Priority setting parameter.
Refer to
for a detailed description.
Func GetDefaultPowerInputContextScopeInfo( oAdminLevel, oLocked) As
Retrieves information about the Default Power Input Context Scope setting parameter.
Refer to
for a detailed description.
Func GetDefaultPowerInputPrefixInfo( oAdminLevel, oLocked) As
Retrieves information about the Default Power Input Prefix setting parameter.
Refer to
for a detailed description.
Func GetMaxDisplayedResultsInfo( oAdminLevel, oLocked) As
Retrieves information about the Max Displayed Results setting parameter.
Refer to
for a detailed description.
Func GetMaxPreHighlightedElementsInfo( oAdminLevel, oLocked) As
Retrieves information about the Max Displayed Results setting parameter.
Refer to
for a detailed description.
Sub SetDeepSearchActivationLock( iLocked)
Locks or unlocks the Deep Search Activation setting parameter.
Refer to
for a detailed description.
Sub SetDefaultPowerInputContextPriorityLock( iLocked)
Locks or unlocks the Default Power Input Context Priority setting parameter.
Refer to
for a detailed description.
Sub SetDefaultPowerInputContextScopeLock( iLocked)
Locks or unlocks the Default Power Input Context Scope setting parameter.
Refer to
for a detailed description.
Sub SetDefaultPowerInputPrefixLock( iLocked)
Locks or unlocks the Default Power Input Prefix setting parameter.
Refer to
for a detailed description.
Sub SetMaxDisplayedResultsLock( iLocked)
Locks or unlocks the Max Displayed Results setting parameter.
Refer to
for a detailed description.
Sub SetMaxPreHighlightedElementsLock( iLocked)
Locks or unlocks the Max Displayed Results setting parameter.
Refer to
for a detailed description.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_SelectedElement_22722 ===
InfInterfaces SelectedElement (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
SelectedElement (Object)
Represents an element contained by a Selection object.
This object is an object contained by a  object. The
object contains
objects, which are accessed through the
and
methods.
Property Index
Document
Returns the document to which the selected element belongs.
LeafProduct
Returns the leaf product corresponding to the selection in the specification tree.
Reference
Returns a Reference version of the Value property.
Type
Returns the string constant which describes the selected element Automation type.
Value
Returns the actual selected automation object.
Method Index
GetCoordinates
Returns the coordinates of the pick point.
Properties
Property Document() As   (Read Only)
Returns the document to which the selected element belongs.
Property LeafProduct() As   (Read Only)
Returns the leaf product corresponding to the selection in the specification tree.
Role: Returns the leaf
(component, corresponding for example to "Product1.1" in the specification tree). The
returned is a
if a product appears in the specification tree, in the path corresponding to the current selection, and a fake
whose
property equals to "InvalidLeafProduct" otherwise. Cumulated with the use of the
property (which enables to navigate into the object structure), the current property enables the scripter to obtain the path, in the specification tree,
corresponding to the selection.
Example:
The following example supposes a
or a
is opened. It asks the end user to select a
in the current window. It then sends message boxes containing the names of the automation objects contained in the specification tree path corresponding to the shape selected, and, regarding the
automation objects which are products (only products which are components), a message box containing the
abcissa of the translation of the product compared to its reference product.
Dim Status,Feature,LeafProduct,LeafProductProcessed,InputObjectType(0)
Dim Document,Selection,AutomationTreeNodeOrProduct,Position,AxisComponentsArray(11)
Set Document = CATIA.ActiveDocument : Set Selection = Document.Selection
'We propose to the user that he select a feature
InputObjectType(0)="AnyObject"
Status=Selection.SelectElement2(InputObjectType,"Select a feature",true)
if (Status = "Cancel") then Exit Sub
Set Feature = Selection.Item(1).Value
Set LeafProduct = Selection.Item(1).LeafProduct
LeafProductProcessed = true
if (LeafProduct.Name<>"InvalidLeafProduct") then LeafProductProcessed = false
Set AutomationTreeNodeOrProduct = Feature
do while (TypeName(AutomationTreeNodeOrProduct)<>"Application")
'  We send a message box, if AutomationTreeNodeOrProduct is not nor a Shapes object neither a PartDocument object
if ((TypeName(AutomationTreeNodeOrProduct)<>"Shapes") And _
(TypeName(AutomationTreeNodeOrProduct)<>"Bodies") And _
(TypeName(AutomationTreeNodeOrProduct)<>"PartDocument") And _
(TypeName(AutomationTreeNodeOrProduct)<>"Products") And _
(TypeName(AutomationTreeNodeOrProduct)<>"ProductDocument")) then
msgbox AutomationTreeNodeOrProduct.Name
if (TypeName(AutomationTreeNodeOrProduct)="Product") then
'          We display a message box containing the abcissa of the translation, except in the case of the
'          root product
if (TypeName(AutomationTreeNodeOrProduct.Parent.Parent)<>"Application") then
Set Position = AutomationTreeNodeOrProduct.Position
Call Position.GetComponents(AxisComponentsArray)
msgbox AxisComponentsArray(9)
end if
end if
end if
'  We determine the next automation tree node or product
Set AutomationTreeNodeOrProduct = AutomationTreeNodeOrProduct.Parent
if ((TypeName(AutomationTreeNodeOrProduct)="Application") And (Not LeafProductProcessed)) then
'      The specification tree path corresponding to the selection contains at least one product, which the current
'      loop as not yet processed. It means that the parent in the specification tree of the feature corresponding
'      to the last message box sent is LeafProduct
Set AutomationTreeNodeOrProduct = LeafProduct
LeafProductProcessed = true
end if
loop
If you run the preceeding piece of script, the current document beeing a product with the following specification
tree:
+--------+
!Product3!
+----+---+
!
+- Product2 (Product2.1)             'translation value: 10
!     !
!     +- Product1 (Product1.1)       'translation value: 20
!           !
!           +- Part1 (Part1.1)
!                !
!                +- Part1
!                     !
!                     +- PartBody
!                           !
!                           +- Pad.1
+- Part2 (Part2.1)
and you select Pad.1, the message boxes displayed will be:
Pad.1
PartBody
Part1
Part1.1
Product1.1
20
Product2.1
10
Product3
Property Reference() As   (Read Only)
Returns a Reference version of the Value property.
Role: Returns a
version of
.
Property Type() As   (Read Only)
Returns the string constant which describes the selected element Automation type.
This type is returned by the
property, and may be, for instance "Pad" or "Line2D".
Caution: This property gives the leaf automation type of the object, in the
inheritance hierarchy. Nevertheless, after a call to
,
,
,
or
,  this property gives the input filter string constant relative to the effective selection (more precisely
the first filter string constant delivered through the iFilterType
parameter, for which the current automation object fullfills the string constant). This string constant may be
an automation object name corresponding to the iFilterType parameter with which
has previously been called, or even a
value name.
Example:
Suppose you run the following piece of script:
Set Selection = CATIA.ActiveDocument.Selection
'  We propose to the user that he select a Prism or a Hole
ReDim InputObjectType(1) : InputObjectType(0)="Prism" : InputObjectType(1)="Hole"
Status=Selection.SelectElement2(InputObjectType,"Select a prism or a hole",true)
if (Status = "Cancel") then Exit Sub
AutomationType = Selection.Item(1).Type
If the user selects a Pad, the script AutomationType variable will contain "Prism"
and not "Pad".
Consequently, in most cases, use the VBScript TypeName function instead of this property.
Property Value() As   (Read Only)
Returns the actual selected automation object.
Methods
Sub GetCoordinates( ioPoint)
Returns the coordinates of the pick point.
Parameters:
oPoint
The coordinates of the pick point, i.e. the hit between the geometric object and the cursor.
The length of this parameter will be 3, except if the document is a
Example:
This example retrieves the coordinates of the pick point in the
array myArray:
Dim oSelElem As SelectedElement
Set oSelElem = CATIA.ActiveDocument.Selection.Item(1)
ReDim myArray(2)
oSelElem.GetCoordinates myArray
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Selection_15704 ===
InfInterfaces Selection (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Selection (Object)
Represents the selection.
The Selection object contains the features the end user selected, usually with the mouse, and which are
candidates as subjects for the next action.
A feature possess parent objects in the specification tree (hierarchy). For example, the Pad below possess
parent objects in the specification tree:
+--------+
!Product3!
+--------+
!
+- Product2 (Product2.1)
!     !
!     +- Product1 (Product1.1)
!           !
!           +- Part1 (Part1.1)
!                !
!                +- Part1
!                     !
!                     +- PartBody
!                           !                      +------------------+
!                           +- Pad.1               ! Selected feature !
!                                !                 +------------------+
!                                +- Sketch.1
+- Part2 (Part2.1)
For a given selected feature, its parent objects which are exposed to automation can be accessed through a
recursive call to the  property. When a given feature is selected, there are three possibilities:
The feature is exposed to automation (a
for example, this is the common case): the feature can be accessed by all Selection object methods
The feature is not exposed to automation, but at least one of its parent objects is exposed to automation
(a DMU Navigator URL for example: the Hyperlink is not exposed to automation, but the root Product, which
contains the Hyperlink, is exposed to automation):
no access is given to the feature through the
and
methods of the Selection  object
nevertheless, the first parent object of the feature, which is exposed to automation (the root Product in our
example) can be accessed through the
and
methods
The
,
,
,
,
,
and
methods of the Selection object, take into account the feature.
For example, if the user:
Puts a DMU Navigator URL in the clipboard
Runs a script calling the PasteSpecial method
then, during the paste, the DMU Navigator URL will be pasted
The feature is not exposed to automation, and he has no parent object which is exposed to automation (a
ResourcesList object of a .CATProcess for example):
no access is given to the feature through the
and
methods of the Selection object
no access is given neither to any parent object of the feature through the
and
methods
The
,
,
,
,
,
and
methods of the Selection object take into account the feature.
For example, if the user:
Go to the "DPM - Process and Resource Definition" workshop
Puts a ResourcesList object in the clipboard
Runs a script calling the Selection.PasteSpecial method
then, during the paste, the ResourcesList object will be pasted.
Note: The
object can be accessed through the
property . However, when the active window contains the tree described above, the
object to use is the one associated to the Product3
, which can be accessed through the application of the
to this document. You will, for example, determine the
object the following way:
Set ActiveProductDocument = CATIA.ActiveDocument
Set Product3 = ActiveProductDocument.Product
Set Product3Products = Product3.Products
Set Product2Dot1 = Product3Products.Item("Product2.1") : Set Product2 = Product2Dot1.ReferenceProduct
Set ProductDocument2 = Product2.Parent
Set Product2Products = Product2.Products
Set Product1Dot1 = Product2Products.Item("Product1.1") : Set Product1 = Product1Dot1.ReferenceProduct
Set ProductDocument1 = Product1.Parent
Set Product1Products = Product1.Products
Set Part1Dot1 = Product1Products.Item("Part1.1") : Set Part1 = Part1Dot1.ReferenceProduct
Set PartDocument1 = Part1.Parent
Set Selection = ActiveProductDocument.Selection
Another
object, such as:
Set ProductDocument2Selection = ProductDocument2.Selection
Set ProductDocument1Selection = ProductDocument1.Selection
Set PartDocument1Selection = PartDocument1.Selection
(lets take ProductDocument2Selection for example) can only be used if, among the different
, there is at least one whose root
is ProductDocument2 . Otherwise, results are unpredictable.
Property Index
Count
Count2
Returns the number of SelectedElement objects contained by the current selection.
VisProperties
Manages graphic properties on current selection.
Method Index
Add
Creates a SelectedElement object which Value property is the given automation object, and adds it to the selection.
Clear
Clears the selection.
Copy
Copies, in a copy and paste operation.
Cut
Cuts, in a cut and paste operation.
Delete
Deletes all selected objects.
FilterCorrespondence
Specifies if the automation objects appearing as Value property of SelectedElement objects fit a given filter.
FindObject
Finds an object in the current selection and deletes it from the selection.
IndicateOrSelectElement2D
Runs an interactive command enabling both indication and selection, 2D version.
IndicateOrSelectElement3D
Runs an interactive command enabling both indication and selection, 3D version.
Item
Item2
Returns the iIndex-th SelectedElement object contained by the current selection.
Paste
Puts the contents of the clipboard in the document at the indicated location.
PasteSpecial
Puts the contents of the clipboard in the document at the indicated location, according to the specified format.
Remove
Remove2
Removes the iIndex-th SelectedElement object contained by the current selection.
Search
Finds an object in the document using the Edit/Search grammar.
SelectElement2
Runs an interactive selection command.
SelectElement3
Runs an interactive selection command, exhaustive version.
SelectElement4
Runs an interactive selection command, enabling the selection in a non active document.
Properties
Property Count() As   (Read Only)
Deprecated:
V5R16 #Count2 . The Count and Item Methods have been replaced by the Count2 and Item2 methods because
they did not process correctly features which are not exposed to automation (such as a ResourcesList feature of a
.CATProcess document).
Property Count2() As   (Read Only)
Returns the number of SelectedElement objects contained by the current selection.
Role: This method returns the number of
objects contained by the Selection.  The Value property of a given
object is an automation object associated to a selected feature.
Property VisProperties() As   (Read Only)
Manages graphic properties on current selection.
Role: Gives a VisPropertySet automation object so that graphic properties of the selected objects can
be read or modified.
Note: After the execution of the VisProperties methods which update graphic properties of the features,
selected features which are not exposed to automation will be updated. After the execution of the VisProperties
methods which consult the selection to give the graphic properties, selected features which are not exposed to
automation will be consulted.
Example:
This example sets in no show all elements of the current selection:
Dim Selection,VisPropertySet
Set Selection = CATIA.ActiveDocument.Selection
Set VisPropertySet = Selection.VisProperties
VisPropertySet.SetShow catVisPropertiesNoShowAttr
Methods
Sub Add( iObject)
Creates a SelectedElement object which Value property is the given automation object, and adds it to the selection.
Note: In a product structure aggregating a "Part1 (Part1.1)" Part document, if you double-clic Part1 in the
spectification tree:
the "Part Design" workbench becomes active
the Part1 node is inside a blue button
Here, Part1 is the UI Active Object.
Some editors, such as
editors, do not possess any UI Active Object. When this method is used in a CATAnalysis context, a CATPart (such as Part1 in our example) must be UI active. Otherwise, Selection.Add does not work correctly (the 3D is not highlighted properly).
Role: Creates a
object and adds it to the current selection. Depending on the  type of the parent
of the
object:
if it is one of the following:
CATIAPartDocument
CATIADrawingDocument
CATIAMaterialDocument
CATIAAnalysisDocument
CATIAFunctionalDocument
then, regarding the created
, the
property will be equal to iObject
Otherwise:
first case: the specification tree contains a path:
whose leaf node is iObject
the UI Active Object belongs to the path
then, the method will create a
object corresponding to this path.
Otherwise: the method will create a
object corresponding to the first path, in the specification tree, whose leaf node is iLeafNode
Example:
This example creates a
object, which Value property is the ObjectToAdd automation object, the
being added to the current selection.
CATIA.ActiveDocument.Selection.Add(ObjectToAdd)
Sub Clear()
Clears the selection.
Example:
This example clears the selection. The selection is then empty.
CATIA.ActiveDocument.Selection.Clear()
Sub Copy()
Copies, in a copy and paste operation.
Role: Puts the contents of the selection in the clipboard,
but leaves the selected elements in the document,
and clears the selection.
This is the programming equivalent of the Copy command from the
Edit menu.
Note: The method (and the script execution) fails if one of the following errors occurs:
The CSO is empty. The Copy operation could not be performed.
No CSO element remains after the filtering through the UI active object. The Copy operation could not be performed.
Note: If a selected feature is not exposed to automation, it will be copied into the clipboard all the
way.
Example:
This example copies, in a copy and paste operation. A selected DMU Navigator URL will be put into the clipboard
although it is not exposed to automation.
CATIA.ActiveDocument.Selection.Copy()
Sub Cut()
Cuts, in a cut and paste operation.
Role: Puts the contents of the selection in the clipboard, and removes the selected elements from the
document,
and clears the selection.
This is the programming equivalent of the Cut command from the
Edit menu.
Note: The method (and the script execution) fails if one of the following errors occurs:
The CSO is empty. The Cut operation could not be performed.
No CSO element remains after the filtering through the UI active object. The Cut operation could not be performed.
Note: If a selected feature is not exposed to automation, it will be copied into the clipboard and removed
from the document all the way.
Example:
This example cuts, in a cut and paste opertation. A selected DMU Navigator URL will be put into the clipboard and
removed from the document, although it is not exposed to automation.
CATIA.ActiveDocument.Selection.Cut()
Sub Delete()
Deletes all selected objects.
Role: For all the
objects contained by the selection, the
automation object is deleted from the document.
Note: If a selected feature is not exposed to automation, it will deleted all the way.
Example:
This example deletes all the selected objects. A selected DMU Navigator URL will be removed from the document,
although it is not exposed to automation.
CATIA.ActiveDocument.Selection.Delete()
Func FilterCorrespondence( iFilterType) As
Specifies if the automation objects appearing as Value property of SelectedElement objects fit a given filter.
Role: FilterCorrespondence filters the selection with respect to provided automation
types. The use of this method coupled with the use of the
will enable to offer a multi-selection written programmatically, which is the common way to write multi-selection is CATIA.
It will enable, for example, to write a script reproducing the functionalities of the "Fillet" command of the
"Part Design" workbench.
This method, called before a loop onto
calls, will enable if all the selection objects correspond to the filter (which will be the same as the filter given to
), to take them into account, and, otherwise, to clear the selection.
This multi-selection written programmatically will generally be used coupled with the fact that already selected
elements remain selected during the selections.
Parameters:
iFilterType
An array of strings constants to be used as a filter for the kind of element to which current selection object
must correspond. See the iFilterType parameter of the
method.
oAllFit
All current selection objects fit the iFilterType filter, i.e. regarding each of the current selection objects,
they all fit one of the iFilterType string constant.
Example:
The following example scripts an edge fillet creation command. It supposes that a part is currently edited,
containing a Pad. It loops onto the following:
it asks the end user to select an edge (see
). If the selected edge has not already been selected, the selected edge is added to the selection, otherwise it is removed from the selection
it asks the end user if another edge has to be selected
until the answer of the user to the preceding question is no.
Then, it creates an edge fillet (see
) taking into account all the selected edges as fillet specifications.
Note: The edges which were selected before the script execution are taken into account. Nevertheless,
if, before the script execution, the selection contained an object which was not a
element, the selection is cleared before the first selection proposal.
Note: During the selection of a given edge, the edges already selected remain highlighted.
Dim Document,Part,Selection,ShapeFactory,EdgeSaveAllocatedCount,EdgeIndex,AllEdgesHaveBeenSelected,AllFit
Dim EdgeSaveCount,SelectedEdge,SelectedElementBelongsToSaveVariables,AlreadySelectedEdgeIndex
Dim OtherEdgeAnswer,Fillet
Set Document = CATIA.ActiveDocument : Set Part = Document.Part : Set Selection = Document.Selection
Set ShapeFactory = Part.ShapeFactory
ReDim InputObjectType(0) : InputObjectType(0)="TriDimFeatEdge" : EdgeSaveCount = 0
'We determine if the selection contains an object which is not a TriDimFeatEdge element
AllFit = Selection.FilterCorrespondence(InputObjectType)
'If the selection contains an object which is not a TriDimFeatEdge element, we clear the selection
if (Not AllFit) then Selection.Clear
EdgeSaveAllocatedCount = Selection.Count+10 : ReDim EdgeSave(EdgeSaveAllocatedCount-1)
'We loop onto interactive selections
AllEdgesHaveBeenSelected = false
do while (Not AllEdgesHaveBeenSelected)
'  We save the selection content in save variables.
'  This corresponds to the fact that:
'    - we want that, during the following call to SelectElement2, the TriDimFeatEdge elements previously selected
'      remain highlighted
'    - this is done using the False value for the iObjectSelectionBeforeCommandUsePossibility
'      parameter of the SelectElement2 method, the selection containing the TriDimFeatEdge elements. It requires that
'      the selection content be saved
if (EdgeSaveAllocatedCount < Selection.Count) then
EdgeSaveAllocatedCount = EdgeSaveAllocatedCount + 10 : ReDim EdgeSave(EdgeSaveAllocatedCount-1)
end if
for EdgeIndex = 0 to Selection.Count2-1
Set EdgeSave(EdgeIndex) = Selection.Item2(EdgeIndex+1).Value
next
EdgeSaveCount = Selection.Count
'  We propose to the user that he select an edge
Status=Selection.SelectElement2(InputObjectType,"Select an edge",false)
if (Status="Cancel") then
Selection.Clear : Exit Sub
end if
'  We save the selected edge in a dedicated variable
Set SelectedEdge = Selection.Item2(1).Value
'  We merge the selected element with the save variables, and put the result in the selection.
'  At first, we determine if the selected edge already belongs to the EdgeSave array
EdgeIndex = 0 : SelectedElementBelongsToSaveVariables = False
do while ((EdgeIndex < EdgeSaveCount) And (Not SelectedElementBelongsToSaveVariables))
if (EdgeSave(EdgeIndex).Name=SelectedEdge.Name) then
SelectedElementBelongsToSaveVariables = True
AlreadySelectedEdgeIndex = EdgeIndex
end if
EdgeIndex = EdgeIndex + 1
loop
'  Effective merge
if (Not SelectedElementBelongsToSaveVariables) then
'      The selected element does not belong to the save variables. We add the save variables to the selection
for EdgeIndex = 0 to EdgeSaveCount-1
Selection.Add EdgeSave(EdgeIndex)
next
else
'      We remove the selected element from the save variables
for EdgeIndex = AlreadySelectedEdgeIndex to EdgeSaveCount-2
Set EdgeSave(EdgeIndex) = EdgeSave(EdgeIndex+1)
next
EdgeSaveCount = EdgeSaveCount - 1
'      We clear the selection
Selection.Clear
'      We add the save variables to the selection
for EdgeIndex = 0 to EdgeSaveCount -1
Selection.Add EdgeSave(EdgeIndex)
next
end if
'  We ask the end user if another edge has to be selected
OtherEdgeAnswer = msgbox ("do you want to select another edge?",3,"Edge Fillet Definition")
if (OtherEdgeAnswer = 2) then Exit Sub
if (OtherEdgeAnswer = 7) then AllEdgesHaveBeenSelected = true
loop
'We create an edge fillet taking into account all the selected edges as fillet specifications
if (Selection.Count > 0) then
Set Fillet = ShapeFactory.AddNewEdgeFilletWithConstantRadius(Selection.Item(1).Value, 1, 5.0)
Fillet.EdgePropagation = 1
for EdgeIndex = 2 to Selection.Count
Fillet.AddObjectToFillet Selection.Item(EdgeIndex).Value
next
Part.Update : Selection.Clear : Selection.Add Fillet
end if
Func FindObject( iObjectType) As
Finds an object in the current selection and deletes it from the selection.
Role: Determines the first automation object specified in
(for the
objects contained in the current selection), or which is a Parent (see
) of the automation object specified in
, which type is equal to the type specified in input. It returns directly the automation object and deletes the corresponding
object from the current selection.
Note: If the string specified in input is he "CATIAProduct" string, the possible automation object
specified in
is also looked at.
Example:
This example searches a Pad object in the
current selection and puts it into FoundObject.
Dim FoundObject As AnyObject
Set FoundObject = CATIA.ActiveDocument.Selection.FindObject("CATIAPad")
Func IndicateOrSelectElement2D( iMessage, iFilterType, iObjectSelectionBeforeCommandUsePossibility, iTooltip, iTriggeringOnMouseMove, oObjectSelected, oDocumentWindowLocation) As
Runs an interactive command enabling both indication and selection, 2D version.
Role: IndicateOrSelectElement2D asks the end user to select either a location into the window,
or a feature (in the geometry or in the specification tree).
During execution, when entering this method, the active document must be a 2D document. See
and
Parameters:
iMessage
A string which instructs the user that he must select a location into the document window or select an object.
iFilterType
An array of strings constants defining the automation object types with which the selection will be filtered.
iObjectSelectionBeforeCommandUsePossibility
Enables the script to support the possibility, for the user, to select a required object before running the script.
See
.
iTooltip
Displays a tooltip as soon as an object is located under the mouse without being selected.
iTriggeringOnMouseMove
Triggers as soon as a mouse move event is detected. This option beeing set, oOutputState may be valued to
"MouseMove".
oObjectSelected
Flag pr�cising if the user choosed the selection or the indication.
oDocumentWindowLocation
An array made of 2 doubles: X, Y - coordinates array of the location the user specified in the document window.
This parameter is valuated only if oObjectSelected equals to false.
oOutputState
The state of the interactive command once IndicateOrSelectElement2D  returns. The possible values are the same than
the values described regarding the oOutputState parameter of the
method, except that the "MouseMove" value can also be returned.
Example:
The following example suppose a drawing is currently edited. It creates a point (see
), and asks the end user to click to define the circle center.
When it is done, as the mouse moves without clicking the left button, the script determines the location into
the drawing window, and the script creates a temporary circle as a feedback.
A click into the document window or the selection of a point creates definitively the circle
(see
) located at the specified location (whether the location is a location into the drawing window or whether it is the existing point location).
Dim Document,Selection,DrawingSheets,DrawingSheet,DrawingViews,WindowLocation(1),DrawingView,Factory2D,Radius,Circle2D
Dim HardCodedPoint,Status,XCenter,YCenter,InputObjectType(0),TempCircleHasBeenCreatedAtLeastOnce,ExistingPoint
Dim ObjectSelected
Set Document = CATIA.ActiveDocument : Set Selection = Document.Selection : Set DrawingSheets  = Document.Sheets
Set DrawingSheet = DrawingSheets.ActiveSheet : Set DrawingViews = DrawingSheet.Views
Set DrawingView = DrawingViews.ActiveView : Set Factory2D = DrawingView.Factory2D
'We create a point
Set HardCodedPoint = Factory2D.CreatePoint(700.,400.)
HardCodedPoint.ReportName = 1 : HardCodedPoint.Construction = False
'We propose to the user to click to define the circle center
Status=Document.Indicate2D("click to define the circle center",WindowLocation)
if (Status = "Cancel" Or Status = "Undo" Or Status = "Redo") then Exit Sub
XCenter = WindowLocation(0) : YCenter = WindowLocation(1)
'We propose to the user that he specify a location into the drawing window or a point
InputObjectType(0)="Point2D"
Status = "MouseMove" : TempCircleHasBeenCreatedAtLeastOnce = 0
Status=Selection.IndicateOrSelectElement2D("select a point or click to locate the circle radius point", _
InputObjectType,false,false,true, _
ObjectSelected,WindowLocation)
' We loop onto mouse moves without click
do while (Status = "MouseMove")
if (TempCircleHasBeenCreatedAtLeastOnce) then
Selection.Add Circle2D : Selection.Delete
end if
Radius = Sqr(((WindowLocation(0)-XCenter)*(WindowLocation(0)-XCenter))+ _
((WindowLocation(1)-YCenter)*(WindowLocation(1)-YCenter)))
Set Circle2D = Factory2D.CreateClosedCircle(XCenter,YCenter,Radius)
TempCircleHasBeenCreatedAtLeastOnce = 1
Status=Selection.IndicateOrSelectElement2D("select a point or click to locate the circle radius point", _
InputObjectType,false,false,true, _
ObjectSelected,WindowLocation)
loop
'We go out if necessary
if (Status = "Cancel" Or Status = "Undo" Or Status = "Redo") then
if (TempCircleHasBeenCreatedAtLeastOnce) then
Selection.Add Circle2D : Selection.Add HardCodedPoint : Selection.Delete
end if
Exit Sub
end if
'We determine the possible selected point coordinates
if (ObjectSelected) then
Set ExistingPoint = Selection.Item2(1).Value : ExistingPoint.GetCoordinates WindowLocation : Selection.Clear
end if
'We clean-up the temporary circle
if (TempCircleHasBeenCreatedAtLeastOnce) then
Selection.Add Circle2D : Selection.Delete
end if
'We create the circle
Radius = Sqr(((WindowLocation(0)-XCenter)*(WindowLocation(0)-XCenter))+ _
((WindowLocation(1)-YCenter)*(WindowLocation(1)-YCenter)))
Set Circle2D = Factory2D.CreateClosedCircle(XCenter,YCenter,Radius) : Selection.Add Circle2D
Func IndicateOrSelectElement3D( iPlanarGeometricObject, iMessage, iFilterType, iObjectSelectionBeforeCommandUsePossibility, iTooltip, iTriggeringOnMouseMove, oObjectSelected, oWindowLocation2D, oWindowLocation3D) As
Runs an interactive command enabling both indication and selection, 3D version.
Role: IndicateOrSelectElement3D asks the end user to select either a location into the window,
or a feature (in the geometry or in the specification tree).
During execution, when entering this method, the active document must be a 3D document. See
and
Parameters:
iPlanarGeometricObject
A planar geometric object.
iMessage
A string which instructs the user that he must select a location into the document window or select an object.
iFilterType
An array of strings constants defining the automation object types with which the selection will be filtered.
iObjectSelectionBeforeCommandUsePossibility
Enables the script to support the possibility, for the user, to select a required object before running the script.
See
.
iTooltip
Displays a tooltip as soon as an object is located under the mouse without being selected.
iTriggeringOnMouseMove
Triggers as soon as a mouse move event is detected. This option beeing set, oOutputState may be valued to
"MouseMove".
oObjectSelected
Flag pr�cising if the user choosed the selection or the indication.
oWindowLocation2D
X, Y - coordinates array of the location the user specified into the document window.
This parameter is valuated only if oObjectSelected equals to false.
oWindowLocation3D
X, Y, Z - coordinates array of the location the user specified in the document window.
This parameter is valuated only if oObjectSelected equals to false.
oOutputState
The state of the interactive command once IndicateOrSelectElement3D  returns. The possible values are the same than
the values described regarding the oOutputState parameter of the
method, except that the "MouseMove" value can also be returned.
Example:
The following example suppose a part is currently edited, containing a plane. It creates a point
(see
), asks the end user to select a location into the part window, onto the Plane.1 plane, or to select a point.
As the mouse moves without clicking the left button, the location into the drawing window is determined, and the
script creates a temporary point as a feedback.
A click into the document window or the selection of a point creates definitively the point
(see
) located at the specified location (whether the location is a location into the part window or whether it is the existing point location).
Dim Document,Part,HybridShapeFactory,Selection,Body,HybridShapePlane,PlaneReference,HardCodedPoint,Point
Dim InputObjectType(0),WindowLocation2D(1),WindowLocation3D(2),TempPointHasBeenCreatedAtLeastOnce,Status
Dim ObjectSelected,ExistingPoint
Set Document = CATIA.ActiveDocument : Set Part = Document.Part
Set HybridShapeFactory = Part.HybridShapeFactory : Set Selection = Document.Selection
Set Body = Part.Bodies.Item("PartBody") : Set HybridShapePlane = Body.HybridShapes.Item("Plane.1")
Set PlaneReference = Part.CreateReferenceFromObject(HybridShapePlane)
'We create a point
Set HardCodedPoint = HybridShapeFactory.AddNewPointOnPlane(PlaneReference,30.,30.)
Body.InsertHybridShape HardCodedPoint : Part.InWorkObject = HardCodedPoint : Part.Update
'We propose to the user that he specify a location into the part window or a point
InputObjectType(0)="HybridShapePointOnPlane"
Status = "MouseMove" : TempPointHasBeenCreatedAtLeastOnce = 0 : Selection.Clear
Status=Selection.IndicateOrSelectElement3D(HybridShapePlane,"select a point or click to locate the point", _
InputObjectType,false,false,true, _
ObjectSelected,WindowLocation2D,WindowLocation3D)
' We loop onto mouse moves without click
do while (Status = "MouseMove")
if (TempPointHasBeenCreatedAtLeastOnce) then
Selection.Add Point : Selection.Delete
end if
Set Point = HybridShapeFactory.AddNewPointOnPlane(PlaneReference,WindowLocation2D(0),WindowLocation2D(1))
Body.InsertHybridShape Point : Part.InWorkObject = Point : Part.Update
TempPointHasBeenCreatedAtLeastOnce = 1
Status=Selection.IndicateOrSelectElement3D(HybridShapePlane,"select a point or click to locate the point", _
InputObjectType,false,false,true, _
ObjectSelected,WindowLocation2D,WindowLocation3D)
loop
'We go out if necessary
if (Status = "Cancel" Or Status = "Undo" Or Status = "Redo") then
if (TempPointHasBeenCreatedAtLeastOnce) then
Selection.Add Point : Selection.Add HardCodedPoint : Selection.Delete : Part.Update
end if
Exit Sub
end if
'We determine the possible selected point coordinates
if (ObjectSelected) then
Set ExistingPoint = Selection.Item2(1).Value
WindowLocation2D(0) = ExistingPoint.XOffset.Value : WindowLocation2D(1) = ExistingPoint.YOffset.Value
Selection.Clear
end if
'We clean-up the temporary point
if (TempPointHasBeenCreatedAtLeastOnce) then
Selection.Add Point : Selection.Delete
end if
'We create the point
Set Point = HybridShapeFactory.AddNewPointOnPlane(PlaneReference,WindowLocation2D(0),WindowLocation2D(1))
Body.InsertHybridShape Point : Part.InWorkObject = Point : Part.Update
Func Item( iIndex) As
Deprecated:
V5R16 #Item2 . The Count and Item Methods have been replaced by the Count2 and Item2 methods because
they did not process correctly features which are not exposed to automation (such as a ResourcesList feature of a
.CATProcess document).
Func Item2( iIndex) As
Returns the iIndex-th SelectedElement object contained by the current selection.
Role: Returns the iIndex-th
object contained by the current Selection. The Value property of the
object is an automation object associated to a selected feature.
Parameters:
iIndex
The index of the
object to return, 1≤iIndex≤Selection.Count2 .
oSelectedElement
The
object
Example:
See the
method first example.
Sub Paste()
Puts the contents of the clipboard in the document at the indicated location.
Role: After the execution of the Paste method, there may be, among the pasted features, some which are
not exposed to automation. If the selected feature after which the clipboard must be pasted is not exposed to
automation, the Paste will be done all the way.
Note: The method (and the script execution) fails if one of the following errors occurs:
The CSO is empty. The Paste operation could not be performed.
No CSO element remains after the filtering through the UI active object. The Paste operation could not be performed.
Example:
This example pastes, in a cut, or copy, and paste operation. A selected DMU Navigator URL will be put into the
clipboard and removed from the document, although it is not exposed to automation.
CATIA.ActiveDocument.Selection.Paste()
Sub PasteSpecial( iFormat)
Puts the contents of the clipboard in the document at the indicated location, according to the specified format.
Role: After the execution of the Paste method, there may be, among the pasted features, some which are
not exposed to automation. If the selected feature after which the clipboard must be pasted is not exposed to
automation, the Paste will be done all the way.
Note: The method (and the script execution) fails if one of the following errors occurs:
The CSO is empty. The PasteSpecial operation could not be performed.
No CSO element remains after the filtering through the UI active object. The PasteSpecial operation could not be performed.
Formats are:
In all the containers
"CATIA_LINK_FORMAT" to paste "Catia Link Source",
"OLE_LINK_FORMAT"   to paste "Ole Link Source",
"OLE_EMBED_FORMAT"  to paste "Ole Embed Source".
In a Part container
"CATPrtCont"              to paste "As Specified In Part Document",
"CATPrtResultWithOutLink" to paste "AsResult",
"CATPrtResult"            to paste "AsResultWithLink",
"CATMaterialCont"         to paste "As material",
"AsMaterialLink"          to paste "As material link",
"CATMechProdCont"         to paste "As specified in Assembly",
"CATProdCont"             to paste "As specified in Product Structure",
"CATIA_SPEC"              to paste "CATIA_SPEC",
"CATIA_RESULT"            to paste "CATIA_RESULT".
Warning:
Using PasteSpecial with CATPrtResult will not copy links between several Part containers. This API does not support it.
It will copy links only for copy paste operations inside the same Part Container.
This is a different behavior from the interactive one.
To perform copy paste operation as result with link between several Part Containers, it must be done interactively.
In a Product container
"CATProdCont"      to paste "As specified in Product Structure",
"CATSpecBreakLink" to paste "Break Link".
In a Process container
"SPPProcessCont" to paste "Simple paste",
"SPP_I"          to paste "Paste with Items",
"SPP_R"          to paste "Paste with Resources",
"SPP_IR"         to paste "Paste with Items and Resources",
"SPPI_I"         to paste "Paste with Items and entire hierarchy",
"SPPI_R"         to paste "Paste with Resources and entire hierarchy",
"SPPI_IR"        to paste "Paste with Items and Resources and entire hierarchy".
In a Material container
"CATMaterialCont" to paste "As material",
"AsMaterialLink"  to paste "As material link".
In a Catalog container
"CATDescriptionFormat" to paste "As defined in catalog instanciation",
"CATCtlgChapterFormat" to paste "As defined in catalog document".
In a Rendering Scene container
"CATRscLightContainer"       to paste "As light",
"CATRscEnvironmentContainer" to paste "As environment",
"CATRscShootingContainer"    to paste "As shooting",
"CATRscTurntableContainer"   to paste "As turntable".
In a Deneb Resource Program container
"DNBProgCont" to paste "Resource Program".
In a Behavior container
"Behaviors" to paste "Behaviors".
In a CATCamera container
"CATCameraContainer" to paste "Camera".
To know more about those formats, refer to the interactive command.
Example:
This example pastes, in a cut, or copy, and paste special operation. A selected DMU Navigator URL will be pasted
from the clipboard at the specified location, although it is not exposed to automation.
CATIA.ActiveDocument.Selection.PasteSpecial "CATPrtResultWithOutLink"
Sub Remove( iIndex)
Deprecated:
V5R16 #Remove2 . This method does the same as the Remove2 method, but it does know how to manage features
which are not exposed to automation (such as a ResourcesList feature of a .CATProcess document).
Sub Remove2( iIndex)
Removes the iIndex-th SelectedElement object contained by the current selection.
Role: Removes the iIndex-th
object contained by the current selection.
Parameters:
iIndex
The index of the
object to remove, 1≤iIndex≤Selection.Count2 .
Example:
This example removes the second
object contained by the current selection.
CATIA.ActiveDocument.Selection.Remove2(2)
Sub Search( iStringBSTR)
Finds an object in the document using the Edit/Search grammar.
Role: Finds an object in the document using the Edit/Search grammar, and fills the selection with
the found objects. A criterium is created, based on the Search grammar, which defines in addition the depth of
the investigation field.
Note: After the execution of the Search method, there may be, among the selected features, some which
are not exposed to automation.
Example:
The following example searches the objects matching the following criterium in all the document:
Part.Sketcher.Color='White' . A selected DMU Navigator URL put into the selection although it is not
exposed to automation.
CATIA.ActiveDocument.Selection.Search("Part.Sketcher.Color='White',all")
Func SelectElement2( iFilterType, iMessage, iObjectSelectionBeforeCommandUsePossibility) As
Runs an interactive selection command.
Role: SelectElement2 asks the end user to select a feature (in the geometry or in the
specification tree) in a
of the active
. During the selection, when the end user will move the mouse above a feature which maps the given filter, the mouse pointer will be the "hand" cursor, and
when end user will move the mouse above a feature which does not map the given filter, the mouse pointer will be
the "no entry" cursor.
If iObjectSelectionBeforeCommandUsePossibility is equal to False:
The end user is asked to interactively select an appropriate element. When this is done, the Selection
object is cleared, and filled with the selected element.
If iObjectSelectionBeforeCommandUsePossibility is equal to True:
SelectElement2 determines whether the automation objects specified in
, for the
objects contained in the current selection, or one of the parents of the automation objects (see
) is an appropriate element:
If it is the case, no interaction is asked to the end user, the Selection object is cleared,
and filled with the appropriate element.
Otherwise, the Selection object is cleared, and the end user is asked to interactively select an
appropriate element. When this is done, the selection is filled with the selected element.
Note: The
object on which the
method must be called must be the
object obtained the following way:
determine the active document, for example, in the following case:
Product3
!
+- Product2 (Product2.1)
!     !
!     ! +---------------------+
!     +-!Product1 (Product1.1)!
!       +----------+----------+
!                  !
!                  +- Part1 (Part1.1)
!                       !
!                       +- Part1
!                            !
!                            +- PartBody
!                                  !                      +------------------+
!                                  +- Pad.1               ! Selected feature !
!                                       !                 +------------------+
!                                       +- Sketch.1
+- Part2 (Part2.1)
it will be Product3
call the
property onto this document
Otherwise, results are unpredictable.
Note: During the selection scan to find an automation object, a "Product" string constant specified in
iFilterType will imply that SelectElement2 will also look at the possible automation object specified
in
. After a call to SelectElement2, if the return value equals to "Normal", a call to the
method will return one, and a call to Item2(1) will return the selected element.
Note: If the scripting language is Visual Basic for Applications or Visual Basic 6 Development Studio, then,
you have to know that the use of an interactive selection method such as this one from a form (dialog box) method
requires some constraints regarding the content of an average form method.
If your macro possess a form method which calls the
method, then, the content of an average form method of your macro must begin by a test, which checks that no form method is currently being executed and,
otherwise, go out of the method. This constraint enable to prevent that, during the execution of the
method from a form method, when CATIA asks the end user to select a feature:
the users select a dialog object of a form (CATIA going on asking the end user to select a feature)
this selection trigger the corresponding form method
this run CATIA automation objects methods, CATIA going on asking the end user to select a feature
which would lead to unpredictable results.
The code will be the following way:
- macro module main variables:
Dim AFormMethodIsBeingExecuted As Boolean
- form method calling SelectElement2:
Private Sub FormPossessingOneMethodCallingSelectElement2_Click()
Dim InputObjectType(0), Status
AFormMethodIsBeingExecuted = True
InputObjectType(0)="TriDimFeatEdge"
Status=Selection.SelectElement2(InputObjectType,"Select an edge",false)
AFormMethodIsBeingExecuted = False
End Sub
- average form method:
Private Sub AverageForm_Click()
If (AFormMethodIsBeingExecuted) Then Exit Sub
. . .
'     content of the form method itself
. . .
End Sub
Parameters:
iFilterType
An array of strings constants defining the automation object types with which the selection will be filtered.
During the selection, when the end user will move the mouse (above the geometry or the specification tree), if
the feature under the mouse does not map iFilterType, the cursor will be the "no entry" cursor.
The resulting filter is a logical OR of the supplied strings constants. For instance if the array contains two
elements "Point" and "Line", when the end user will move the mouse above the geometry, if
there is a feature under a mouse, which is a
object (you have to know that the
object is a parent object of the
object ), then, the cursor will be a "hand" cursor. At the opposite, if there is a feature under a mouse, which is neither a
nor a
, the cursor will be a "no entry" cursor.
Beside the automation object names, the
value names are supported.
iMessage
A string which instructs the user what to select. This string is displayed in the message
area located at the left of the power input area.
iObjectSelectionBeforeCommandUsePossibility
Enables the script to support the possibility, for the user, to select a required object before running the script.
If the scripter:
writes a script calling SelectElement2, giving as iFilterType parameter an array containing one string: "Pad"
for the first call to SelectElement2 made by the script, the iObjectSelectionBeforeCommandUsePossibility is
set to True
the scripter associates the script to an Icon. He will proceed as following:
in the Tools menu, select the Customize item. A window appears.
select the Commands Tab. The window contains two lists.
in the list on the left, select the Macros value
select the "Show Properties" push button
select the button on the right of the Icon label. A window containing a list of icons appears
select an Icon
select the Close button. The window containing the icon list disappears
in the list on the right, push the key 1 of the mouse, the cursor beeing on the macro to associate to an Icon.
Then drag to a desired Toolbar. The Icon has been added to the Toolbar.
Then the user will be able to implement the following scenario:
select a Pad
select the Icon mentioned above. This runs the script.
During the execution of the script, the script will detect that the selected Pad is required as input,
and the first call to SelectElement2 will not ask to the user to interactively select a Pad: the Pad
selected before the script execution will be taken.
Note:Regarding the features selected by the user (a Pad in the example above), all the automation objects
specified in
for the current selection
objects must be used: if an automation object specified in
is not asked by the input filter, the SelectElement2 method will ask the user to interactively select an appropriate element.
A False value for the iObjectSelectionBeforeCommandUsePossibility parameter may be used although the selection
is not empty before entering the method. This enables that, during the selection, the selected elements remain
highlighted.
Caution: After a call to
, the iObjectSelectionBeforeCommandUsePossibility parameter being set to False, the elements which were selected before the call to
are not any more in the selection (unless the user selected one of them!). Consequently, such a use of the False value for the
iObjectSelectionBeforeCommandUsePossibility parameter requires the following code:
save the selection content in save variables
call the
method, the iObjectSelectionBeforeCommandUsePossibility parameter being set to False
copy the selected element to a dedicated variable
merge the selected element with the save variables, and put the result in the selection. This mean:
if the selected element does not belong to the save variables, add the save variables to the selection
otherwise, remove the selected element from the save variables, clear the selection and then, add the save
variables to the selection
oOutputState
The state of the selection command once SelectElement2 returns. It can be either "Normal"
(the selection has succeeded), "Cancel" (the user wants to cancel the VB command, which must
exit immediately), "Undo" or "Redo".
Note:The "Cancel" value is returned if one of the following cases occured:
an external command has been selected
the ESCAPE key has been selected
another window has been selected, the window document beeing another document than the current document
Caution:All scripts should exit (after the necessary cleanings) when the "Cancel" value is returned.
If the script does not exit (beside the cleanings) when the "Cancel" value is returned, but calls another
interactive method such as
, and, during execution, the user select an external command (which triggers the return of the "Cancel" value), then, the execution of the other interactive method will display
an error message.
Example:
The following example asks the end user to select a sketch (see
) in the current  window, and creates a Pad (see
). If, before the script execution, a sketch was already selected, it will be taken into account and the end user will ne be asked to select a sketch.
Then, it asks the end user to select an edge of the pad, and creates an edge fillet. Then, is asks the end user to
select a 1-D entity whose geometry is rectilinear (see
), such as an edge of the Pad.
Then, it asks the end user to select a pad face perpendicular to the 1-D entity previously selected. Then, it
creates a hole at the face selected point, the hole direction being the direction of the 1-D selected entity.
During the face selection, the 1-D entity previously selected is highlighted.
Dim Document,Part,Selection,ShapeFactory,SketchHasBeenAcquiredAtLeastOnce,EdgeHasBeenAcquiredAtLeastOnce
Dim FaceHasBeenAcquiredAtLeastOnce,MonoDimEntityHasBeenAcquiredAtLeastOnce,FirstExtrudeNotFinished,FilletEdge
Dim PadNotFinished,Status,SketchForPad,Pad,FilletNotFinished,Fillet,MonoDimEntityDeterminationNotFinished
Dim SelectedElement,MonoDimEntity,HoleNotFinished,PadFace,Hole,InputObjectType(0),HoleLocation(2),MonoDimEntitySave
Dim SketchForPadPartBody
Set Document = CATIA.ActiveDocument : Set Part = Document.Part : Set Selection = Document.Selection
Set ShapeFactory = Part.ShapeFactory
SketchHasBeenAcquiredAtLeastOnce = False : EdgeHasBeenAcquiredAtLeastOnce = False
FaceHasBeenAcquiredAtLeastOnce = False : MonoDimEntityHasBeenAcquiredAtLeastOnce = False
FirstExtrudeNotFinished = True : PadNotFinished = True : ReDim SelectionAtBeginning(1)
'We save the current selection content
ReDim SelectionAtBeginning(Selection.Count2)
for SelectionObjectIndex = 0 to Selection.Count2-1
Set SelectionAtBeginning(SelectionObjectIndex) = Selection.Item2(1).Value
next
SelectionAtBeginningLength = Selection.Count2
'Feature creation
do while PadNotFinished
'  We propose to the user that he select a sketch
InputObjectType(0)="Sketch"
Status=Selection.SelectElement2(InputObjectType,"Select a sketch",true)
if ((Status = "Cancel") Or (Status = "Undo")) then
'      We restore the selection to its initial content
Selection.Clear
for SelectionObjectIndex = 0 to SelectionAtBeginningLength-1
Selection.Add SelectionAtBeginning(SelectionObjectIndex)
next
Exit Sub
elseif (Status = "Redo" And Not SketchHasBeenAcquiredAtLeastOnce ) then
'      We do nothing: Redo has no meaning in this context
else
if (Status <> "Redo") then Set SketchForPad = Selection.Item2(1).Value
SketchHasBeenAcquiredAtLeastOnce = True
'      We determine the PartBody corresponding to the Sketch
Set SketchForPadPartBody = SketchForPad.Parent.Parent
'      We create the Pad
Set Pad = ShapeFactory.AddNewPad(SketchForPad,20.0)
Pad.SecondLimit.Dimension.Value = 0.0 : Part.Update
PadNotFinished = False
Selection.Clear
'      We create the fillet and the hole
FilletNotFinished = True
do while (FilletNotFinished And Not PadNotFinished)
'          We propose to the user that he select an edge
InputObjectType(0)="TriDimFeatEdge"
Status=Selection.SelectElement2(InputObjectType,"Select an edge of the Pad",false)
if (Status = "Cancel") then
'              We remove the pad, restore the selection to its initial content and go out
Selection.Clear : Selection.Add(Pad) : Selection.Delete
Part.Update
Selection.Clear
for SelectionObjectIndex = 0 to SelectionAtBeginningLength-1
Selection.Add SelectionAtBeginning(SelectionObjectIndex)
next
Exit Sub
elseif (Status = "Redo" And Not EdgeHasBeenAcquiredAtLeastOnce ) then
'              We do nothing: Redo has no meaning in this context
elseif (Status = "Undo") then
'              We copy the sketch to the clipboard
Selection.Clear : Selection.Add(SketchForPad)
'              We remove the pad
Selection.Clear : Selection.Add(Pad) : Selection.Delete : Part.Update
'              We re-create the sketch
Selection.Clear : Selection.Add(SketchForPadPartBody) : Selection.Paste()
'              We store the fact that the Pad is not finished
PadNotFinished = True
else
if (Status <> "Redo") then Set FilletEdge = Selection.Item2(1).Value
EdgeHasBeenAcquiredAtLeastOnce = True
'              Create the Fillet
Set Fillet = ShapeFactory.AddNewSolidEdgeFilletWithConstantRadius(FilletEdge, catTangencyFilletEdgePropagation,5.0)
Part.Update
FilletNotFinished = False
Selection.Clear
'              Determine the 1-D entity
MonoDimEntityDeterminationNotFinished = True
do while (MonoDimEntityDeterminationNotFinished And Not FilletNotFinished)
'                  We propose to the user that he select 1-D entity whose geometry is rectilinear
InputObjectType(0)="RectilinearMonoDim"
Status=Selection.SelectElement2(InputObjectType, _
"Select a 1-D entity whose geometry is rectilinear",false)
if (Status = "Cancel") then
'                      We remove the fillet, the pad, restore the selection to its initial content and go out
Selection.Clear : Selection.Add(Fillet) : Selection.Delete
Selection.Clear : Selection.Add(Pad) : Selection.Delete
Part.Update
Selection.Clear
for SelectionObjectIndex = 0 to SelectionAtBeginningLength-1
Selection.Add SelectionAtBeginning(SelectionObjectIndex)
next
Exit Sub
elseif (Status = "Redo" And Not MonoDimEntityHasBeenAcquiredAtLeastOnce ) then
'                      We do nothing: Redo has no meaning in this context
elseif (Status = "Undo") then
'                      We remove the fillet
Selection.Clear : Selection.Add(Fillet) : Selection.Delete
Part.Update
FilletNotFinished = True
else
if (Status = "Redo") then
Selection.Clear : Selection.Add(MonoDimEntity)
else
Set SelectedElement = Selection.Item2(1)
Set MonoDimEntity = SelectedElement.Value
end if
MonoDimEntityHasBeenAcquiredAtLeastOnce = True
MonoDimEntityDeterminationNotFinished = False
'                      Create the Hole
HoleNotFinished = True
do while (HoleNotFinished And Not MonoDimEntityDeterminationNotFinished)
'                          We save the selection content in save variables.
'                          This corresponds to the fact that:
'                            - we want that, during the following call to SelectElement2, the 1-D entity previously
'                              selected remain highlighted
'                            - this is done using the False value for the iObjectSelectionBeforeCommandUsePossibility
'                              parameter, the selection containing the 1-D entity. It requires that the selection
'                              content be saved
Set MonoDimEntitySave = Selection.Item2(1).Value
'                          We propose to the user that he select a face
InputObjectType(0)="Face"
Status=Selection.SelectElement2(InputObjectType, _
"Select a face perpendicular to the 1-D entity",false)
if (Status = "Cancel") then
'                              We remove the fillet, the pad, restore the selection to its initial content and go out
Selection.Clear : Selection.Add(Fillet) : Selection.Delete
Selection.Clear : Selection.Add(Pad) : Selection.Delete
Selection.Clear
for SelectionObjectIndex = 0 to SelectionAtBeginningLength-1
Selection.Add SelectionAtBeginning(SelectionObjectIndex)
next
Part.Update
Exit Sub
elseif (Status = "Redo" And Not FaceHasBeenAcquiredAtLeastOnce ) then
'                              We do nothing: Redo has no meaning in this context
elseif (Status = "Undo") then
Selection.Clear
'                              The 1-D entity must be re-selected
MonoDimEntityDeterminationNotFinished = True
else
if (Status <> "Redo") then
Set SelectedElement = Selection.Item2(1)
Set PadFace = SelectedElement.Value
SelectedElement.GetCoordinates HoleLocation
'                                  We merge the selected element with the save variables, and put the result in the selection
Selection.Add MonoDimEntitySave
end if
FaceHasBeenAcquiredAtLeastOnce = True
'                              We create the Hole
Set Hole = Part.ShapeFactory.AddNewHoleFromPoint(HoleLocation(0),HoleLocation(1),HoleLocation(2),PadFace,10.0)
Hole.ThreadingMode = 1 : Hole.ThreadSide = 0 : Hole.Diameter.Value = 5.0
Hole.SetDirection FilletEdge
Part.Update
HoleNotFinished = False
'                              We clear the selection
Selection.Clear
end if
loop
end if
loop
end if
loop
end if
loop
Func SelectElement3( iFilterType, iMessage, iObjectSelectionBeforeCommandUsePossibility, iMultiSelectionMode, iTooltip) As
Runs an interactive selection command, exhaustive version.
Role: SelectElement3 asks the end user to select a feature (in the geometry or in the
specification tree). It is identical to the
method except that it manages complex uses through the specification of 2 more parameters.
Parameters:
iFilterType
An array of strings constants defining the automation object types with which the selection will be filtered.
iMessage
A string which instructs the user what to select. This string is displayed in the message
area located at the left of the power input area.
iObjectSelectionBeforeCommandUsePossibility
Enables the script to support the possibility, for the user, to select required object(s) before running the script.
See
.
iMultiSelectionMode
The type of multi-selection which will be offered to the user.
iTooltip
Displays a tooltip as soon as an object is located under the mouse without being selected.
oOutputState
The state of the selection command once SelectElement3 returns. It can be either "Normal", "Cancel", "Undo"
or "Redo". See
.
Example:
This first example asks the end user to select several points (see
) into the current Part window, drawing a trap, and performs a symmetry with respect to the XZ plane on the selected points
(see
). The points can be selected before the script be run.
Dim Document,Part,Selection,HybridShapeFactory,HybridBodies,HybridBody,OriginElements,Plane,PlaneReference,Status
Dim InputObjectType(0),PointIndex,PointReference,HybridShapeSymmetry
Set Document = CATIA.ActiveDocument : Set Part = Document.Part : Set Selection = Document.Selection
Set HybridShapeFactory = Part.HybridShapeFactory
Set Bodies = Part.Bodies
Set Body = Bodies.Item("PartBody")
Set OriginElements = Part.OriginElements
Set Plane = OriginElements.PlaneZX
Set PlaneReference = Part.CreateReferenceFromObject(Plane)
'We propose to the user that he select several points, drawing a trap
InputObjectType(0)="Point"
Status=Selection.SelectElement3(InputObjectType,"Select points", _
true,CATMultiSelTriggWhenSelPerf,false)
if (Status = "Cancel") then Exit Sub
For PointIndex = 1 to Selection.Count2
Set PointReference = Part.CreateReferenceFromObject(Selection.Item2(PointIndex).Value)
Set HybridShapeSymmetry = HybridShapeFactory.AddNewSymmetry(PointReference,PlaneReference)
HybridShapeSymmetry.VolumeResult = False
Body.InsertHybridShape HybridShapeSymmetry
Part.InWorkObject = HybridShapeSymmetry
Part.Update
next
Selection.Clear
Example:
This second example illustrates the use of the CATMultiSelTriggWhenUserValidatesSelection value for the
iMultiSelectionMode parameter. This example is a training tool enabling the user to learn how to use the "Symmetry"
command of the "Geometry Modification" toolbar of the Drafting workbench.
It creates a drawing containing a line and three points, and guides the user in:
the selection of points
the selection of the symmetry axis
the selected points being moved by symmetry according to the selected axis.
'We create a drawing
Set Documents = CATIA.Documents : Set Document = Documents.Add("Drawing") : Document.Standard = catISO
Set DrawingSheets = Document.Sheets : Set DrawingSheet = DrawingSheets.Item("Sheet.1")
DrawingSheet.PaperSize = catPaperA0 : DrawingSheet.Scale = 1.000000 : DrawingSheet.Orientation = catPaperLandscape
Set DrawingViews = DrawingSheet.Views : Set DrawingView = DrawingViews.ActiveView
Set Factory2D = DrawingView.Factory2D : Set Selection = Document.Selection : Dim Coordinates(2)
ReDim InputObjectType(0) : Dim SelectedPoint(3) : SelectedPointCount = 0
'We create a horizontal line with a zero ordinate
Set LineLeftExtremity = Factory2D.CreatePoint(-100.0, 0.0) : LineLeftExtremity.ReportName = 3
Set LineRightExtremity = Factory2D.CreatePoint(100.0, 0.0) : LineRightExtremity.ReportName = 4
Set Line2D = Factory2D.CreateLine(-100.0, 0.0, 100.0, 0.0) : Line2D.ReportName = 5
Line2D.StartPoint = LineLeftExtremity : Line2D.EndPoint = LineRightExtremity
'We create three points
Set Point2D1 = Factory2D.CreatePoint(-50.0, 50.0) : Point2D1.ReportName = 6 : Point2D1.Construction = False
Set Point2D2 = Factory2D.CreatePoint(0.0, 70.0) : Point2D2.ReportName = 7 : Point2D1.Construction = False
Set Point2D3 = Factory2D.CreatePoint(50.0, 50.0) : Point2D3.ReportName = 8 : Point2D3.Construction = False
'We mention to the user that he will select the set of elements to be symmetrized
msgbox "This tool will enable you to learn how to use the Symmetry command." & Chr(13) & Chr(13) & _
"Suppose you selected the Symmetry command." & Chr(13) & _
"You will first select several points to be symmetrized"
'We propose to the user that he select several points
InputObjectType(0)="Point2D"
Status=Selection.SelectElement3(InputObjectType,"Select the set of elements to be symmetrized", _
true,CATMultiSelTriggWhenUserValidatesSelection,false)
if (Status = "Cancel") then Exit Sub
'We add the selected points to SelectedPoint
for PointIndex = 0 to Selection.Count2-1
Set SelectedPoint(PointIndex) = Selection.Item2(PointIndex+1).Value : SelectedPointCount = SelectedPointCount+1
next
'We mention to the user that he will select the axis from which the elements will remain equidistant
msgbox "You will then select the line from which the elements will remain equidistant"
'We propose to the user that he select the line
InputObjectType(0)="Line2D"
Status=Selection.SelectElement2(InputObjectType, _
"Select the line or axis from which the elements will remain equidistant", false)
if (Status = "Cancel") then Exit Sub
'We move the selected points by symmetry according to the selected line
for PointIndex = 0 to SelectedPointCount-1
Set CurrentPoint2D = SelectedPoint(PointIndex)
CurrentPoint2D.GetCoordinates Coordinates
CurrentPoint2D.SetData Coordinates(0), -Coordinates(1)
next
Selection.Clear
'We mention to the user that the points have successfully been moved
msgbox "The points have successfully been moved."
Func SelectElement4( iFilterType, iActiveDocumentMessage, iNonActiveDocumentMessage, iTooltip, oDocument) As
Runs an interactive selection command, enabling the selection in a non active document.
Role: SelectElement4 asks the end user to select a feature (in the geometry or in the
specification tree) of a non active document. During the selection, when end user will move the mouse above
a window corresponding to a non active document, when he will move the mouse above a feature which maps the given
filter, the mouse pointer will be the "hand" cursor. When he will move the mouse above a feature which does not map
the given filter, the mouse pointer will be the "no entry" cursor.
This method may be used, for example, to write a script which does the following:
a drawing is currently edited
request that the user select a reference plane in the 3D geometry (a part)
creation of a front view in the drawing, projecting the 3D geometry onto the selected reference plane
Compared to the
, the result of the selection will not be accessed through the
and
methods of the current selection object, but through the
and
methods of the Selection object aggregated by the
object returned through the oDocument parameter. Note:The Selection object aggregated by the
object returned through the oDocument parameter is emptied by before the effective interactive selection.
Parameters:
iFilterType
An array of strings constants defining the automation object types with which the selection will be filtered.
iActiveDocumentMessage
A string which instructs the user what to select, which will be displayed into the active document. This string is
displayed in the message area located at the left of the power input area.
iNonActiveDocumentMessage
A string which instructs the user what to select, which will be displayed into the non active document.
iTooltip
Displays a tooltip as soon as an object is located under the mouse without being selected.
oOutputState
The state of the selection command once SelectElement3 returns. It can be either "Normal", "Cancel", "Undo".
Example:
The following example supposes a part, containing a pad, and drawing are currently edited, the drawing
window beeing the current window. It asks the end user to select a 2-D topological entity, such as a
, in a part. Then it creates a front view in the drawing, projecting the 3D geometry onto the selected 2-D topological entity.
Dim DrawingSelection,DrawingSheets,DrawingSheet,DrawingViews,DrawingFrontView : ReDim DrawingSelectionAtBeginning(1)
Dim Status,InputObjectType(0),Plane,Drawing,DrawingViewGenerativeBehavior,V1(2),V2(2),PartDocument
Set Drawing = CATIA.ActiveDocument : Set DrawingSelection = Drawing.Selection : Set DrawingSheets  = Drawing.Sheets
Set DrawingSheet = DrawingSheets.ActiveSheet
'We save the current selection content
ReDim DrawingSelectionAtBeginning(DrawingSelection.Count2)
for SelectionObjectIndex = 0 to DrawingSelection.Count2-1
Set DrawingSelectionAtBeginning(SelectionObjectIndex) = DrawingSelection.Item2(1).Value
next
SelectionAtBeginningLength = DrawingSelection.Count2
'Feature creation
InputObjectType(0)="BiDimInfinite"
Status=DrawingSelection.SelectElement4(InputObjectType,"Select a 2-D topological entity in a 3-D geometry", _
"Select a 2-D topological entity",false,PartDocument)
if ((Status = "Cancel") Or (Status = "Undo") Or (Status = "Redo")) then
'  We restore the selection to its initial content
PartDocument.Selection.Clear
for SelectionObjectIndex = 0 to SelectionAtBeginningLength-1
DrawingSelection.Add DrawingSelectionAtBeginning(SelectionObjectIndex)
next
Exit Sub
else
Set BiDimFeature = PartDocument.Selection.Item2(1).Value
BiDimFeatureType = TypeName(BiDimFeature)
if ((BiDimFeatureType="Plane") Or (BiDimFeatureType="PlanarFace")) then
BiDimFeature.GetFirstAxis V1
BiDimFeature.GetSecondAxis V2
else
Exit Sub
end if
'  We create a view called "Front View" in the current sheet, using Plane as projection plane, and whose origin
'  coordinates are 300,150
Set DrawingFrontView = DrawingSheet.Views.Add("Front View")
Set DrawingViewGenerativeBehavior = DrawingFrontView.GenerativeBehavior
DrawingViewGenerativeBehavior.Document = PartDocument
DrawingViewGenerativeBehavior.DefineFrontView V1(0), V1(1), V1(2), V2(0), V2(1), V2(2)
DrawingFrontView.x = 300
DrawingFrontView.y = 150
DrawingViewGenerativeBehavior.Update
'  We clear the PartDocument Selection object
PartDocument.Selection.Clear
end if
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_SelectionSets_20117 ===
InfInterfaces SelectionSets (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
SelectionSets (Object)
Interface to manage the Selection Sets in a document.
Method Index
AddCSOIntoSelectionSet
Adds CSO's content in a Selection Set.
CreateSelectionSet
Creates a new Selection Set.
DeleteSelectionSet
Deletes a Selection Set.
GetListOfSelectionSet
Retrieves the list of Selection Sets in the document.
PutSelectionSetIntoCSO
Puts Selection Set's content in the CSO.
RenameSelectionSet
Renames a Selection Set.
Methods
Sub AddCSOIntoSelectionSet( iSelSetName)
Adds CSO's content in a Selection Set.
Parameters:
iSelSetName
The name of the Selection Set in wich the CSO has to be added.
Returns:
The error code of function :
S_OK if the content of the CSO is added
E_FAIL if the content of the CSO  is not added
Sub CreateSelectionSet( iSelSetName)
Creates a new Selection Set.
Role: This method creates a new Selection Set.
Parameters:
iSelSetName
The name of Selection Set to create.
Returns:
The error code of function :
S_OK if the Selection Set is created
E_FAIL if a problem occurred
Sub DeleteSelectionSet( iSelSetName)
Deletes a Selection Set.
Role: This method removes a Selection Set and all its content.
Parameters:
iSelSetName
The Selection Set to delete.
Returns:
The error code of function :
S_OK if the method succeeded
E_FAIL if a problem occurred
Sub GetListOfSelectionSet( oListOfSelectionSet)
Retrieves the list of Selection Sets in the document.
Parameters:
oListOfSelectionSet
The list of Selection Sets in the document
Returns:
The error code of function :
S_OK if the method succeeded
E_FAIL if an error occurred
Sub PutSelectionSetIntoCSO( iSelSetName)
Puts Selection Set's content in the CSO.
Parameters:
iSelSetName
The name of the Selection Set to put in the CSO.
Returns:
The error code of function :
S_OK if the content of the Selection Set is added in the CSO
E_FAIL if the content of the Selection Set is added in the CSO
Sub RenameSelectionSet( iOldSelSetName, iNewSelSetName)
Renames a Selection Set.
Parameters:
iOldSelSetName
The original name of the Selection Set.
iNewSelSetName
The new name of the Selection Set.
Returns:
The error code of function :
S_OK if the name is changed
E_FAIL if the name is not changed
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_SendToService_19863 ===
InfInterfaces SendToService (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
SendToService (Object)
This interface allows to use 'Send To' functionalities
through an API.
Example:
Set Send=CATIA.CreateSendTo()
This interface requires the installation of CATIA - PPR xPDM Gateway 1 Product (PX1)
or the installation of the CATIA-SmarTeam plugin.
In case one of these products is not granted,
the first invocation to one of CATIASendToService methods will fail.
Method Index
AddFile
Adds a file to the list of the files 'to be copied'.
GetLastSendToMethodError
Retreives the diagnosis related to the last call to SendToService interface.
GetListOfDependantFile
Retreives the complete list of the files recursively pointed by the
file given in argument to SetInitialFile method.
GetListOfToBeCopiedFiles
Retreives the complete list of the files that will be copied.
KeepDirectory
Controls the directory tree structure in the target directory.
RemoveFile
Removes a file from the list of the files that will be copied.
Run
Executes the copy action, according to previously set files and options.
SetDirectoryFile
Positions the destination directory.
SetDirectoryOneFile
Allows positioning the destination directory for one given file to be copied.
SetInitialFile
Sets the initial file to be copied.
SetRenameFile
Renames one file to be copied.
Methods
Sub AddFile( iPath)
Adds a file to the list of the files 'to be copied'.
This method verifies that the given input file is valid (exists and is not a directory),
it recursively adds pointed files.
Parameters:
iPath
: The path of the file to be added to the list of the 'to be copied' files.
Example:
Send.AddFile(iPath)
Sub GetLastSendToMethodError( oErrorParam, oErrorCode)
Retreives the diagnosis related to the last call to SendToService interface.
Parameters:
oErrorParam
A parameter string given together with the error code.
oErrorCode
The last executed method error code:
code diagnosisoErrorParam value
0  action successfully performed :-)
1  PX1 license not granted
2  internal error
5  file already in the list  file name
6  file is not in the list   file name
7  empty file list
8  missing target directory
9  no common root directory
10  file does not exist   file name
11  input is a directory   directory name
12  directory check failed directory name
13  invalid file name given name
14  file has no read permission given name
36  allocation failed :-(
Sub GetListOfDependantFile( oDependant)
Retreives the complete list of the files recursively pointed by the
file given in argument to SetInitialFile method.
Notice : in case AddFile has also been invoked, the files recursively
pointed by the added file also are retreived.
Parameters:
oDependant
: The table of dependant files. Example:
Send.GetListOfDependantFile(oDependant)
Sub GetListOfToBeCopiedFiles( oWillBeCopied)
Retreives the complete list of the files that will be copied. This list matches the list
of dependant files, but without the files for which RemoveFile has been invoked.
Parameters:
oWillBeCopied
: The table of the files that will be copied. Example:
Send.GetListOfToBeCopiedFiles(oWillBeCopied)
Sub KeepDirectory( iKeep)
Controls the directory tree structure in the target directory.
Parameters:
iKeep
=1: to preserve the relative tree structure of the files.
This option will be effective only if there is a common root directory for all files.
iKeep
=0: to copy the files directly in the destination directory  Example:
Send.KeepDirectory(ikeep)
Sub RemoveFile( iFile)
Removes a file from the list of the files that will be copied.
Parameters:
iFile
: The File (With extension) to be removed from the list of the 'to be copied' files.
Example:
Send.RemoveFile(iFile)
Sub Run()
Executes the copy action, according to previously set files and options.
A "report.txt" report file is generated in the specified destination directory.
Sub SetDirectoryFile( iDirectory)
Positions the destination directory.
This method verifies that the given directory exists.
Be careful, if SetDirectoryOneFile method has been previously called,
its action is overriden by this SetDirectoryFile call.
Parameters:
iDirectory
: The destination directory where the files will be copied.  Example:
Send.SetDirectoryFile(iDirectory)
Sub SetDirectoryOneFile( iFile, iDirectory)
Allows positioning the destination directory for one given file to be copied.
The file will be copied in the specified target directory.
Be careful that using this method implies that
the 'KeepDirectory' variable will be automatically set to 0.
Parameters:
iFile
: The name (Name With extension) of the given file.
iDirectory
: The directory where this file will be copied.  Example:
Send.SetDirectoryOneFile(iFile, iDirectory)
Sub SetInitialFile( iPath)
Sets the initial file to be copied.
This method verifies that the given input file is valid (exists and is not a directory)
It generates a complete list of the recursively dependent files to be copied.
Example:
This example positions the file of path ipath in the list
of 'to be copied' files. All its dependant files will
also be added in the list of 'to be copied' files.
Parameters:
iPath
: Full path of the file to be copied.
Send.SetInitialFile(iPath)
Sub SetRenameFile( iOldname, iNewName)
Renames one file to be copied.
The new name may not have invalid characters
Parameters:
iOldname
: The old file name (With extension).
iNewName
: The new file name (Without extension). Example:
Send.SetRenameFile(iOldname, iNewName)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_SettingControllers_28393 ===
InfInterfaces SettingControllers (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
SettingControllers (Object)
A collection of all the setting controllers objects currently managed by the
application.
Method Index
Item
Returns a setting controller using its name from the setting controllers collection.
Methods
Func Item( iIndex) As
Returns a setting controller using its name from the setting controllers collection.
Parameters:
iIndex
The name of the window to retrieve from
the collection of setting controller.
As a string.
Returns:
The retrieved setting controller.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_SpecsAndGeomWindow_27611 ===
InfInterfaces SpecsAndGeomWindow (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
SpecsAndGeomWindow (Object)
Represents a window featuring a specification viewer and
a geometry viewer.
The specification viewer is located in the left part of the window
and displays the document's specification tree.
The geometry viewer is located in the right part of the window and
displays the document's geometry, and can thus
be a Viewer2D or a Viewer3D, according to the document type.
Even if generally the two viewers are simultaneously displayed,
one viewer or the other can be hidden thanks to the
CatSpecsAndGeomWindowLayout enumeration.
See also:
Property Index
Layout
Returns or sets the specification and geometry window layout.
SpecsViewer
Returns the specifications viewer.
Properties
Property Layout() As
Returns or sets the specification and geometry window layout.
Example:
This example sets the specification and geometry window layout for the
MyCADWindow window to catWindowGeomOnly.
MyCADWindow.Layout = catWindowGeomOnly
Property SpecsViewer() As   (Read Only)
Returns the specifications viewer.
Example:
This example retrieves the specification viewer for the
MyCADWindow window.
Dim MyViewer As Viewer
Set MyViewer = MyCADWindow.SpecsViewer
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_SpecsViewer_17660 ===
InfInterfaces SpecsViewer (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
SpecsViewer (Object)
Represents the specification tree viewer.
This viewer displays the document's specification tree according to
the chosen layout, and can only be included in a SpecsAndGeomWindow
object.
See also:
,
Property Index
Layout
Returns or sets the specification tree layout.
Properties
Property Layout() As
Returns or sets the specification tree layout.
Example:
This example sets the specification tree layout for the
SpecsTreeViewer
specification tree viewer to catSpecsViewerHorizontalCentered.
SpecsTreeViewer.Layout = catSpecsViewerHorizontalCentered
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_SystemConfiguration_30160 ===
InfInterfaces SystemConfiguration (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
SystemConfiguration (Object)
Provides abstractions to resources which depend on the platform or the current configuration.
Property Index
OperatingSystem
Returns a string which identifies the operating system on
which the application is currently running.
ProductCount
Returns the number of product names names currently known to the
system.
Release
Returns the CATIA release number.
ServicePack
Returns the CATIA service pack number.
Version
Returns the CATIA version number (usually version 5).
Method Index
GetProductNames
Returns the product names of all the licenses currently known to the
system.
IsProductAuthorized
Returns True if the specified product is authorized, False otherwise.
Properties
Property OperatingSystem() As   (Read Only)
Returns a string which identifies the operating system on
which the application is currently running. Examples of
identifiers include: intel_a, solaris_a, aix_a,
win_a and hpux_a.
Parameters:
oOperatingSystem
The operating system identifier.
Property ProductCount() As   (Read Only)
Returns the number of product names names currently known to the
system.
Parameters:
oProductCount
The number of product names currently known to the system.
Property Release() As   (Read Only)
Returns the CATIA release number.
Parameters:
oVersion
The CATIA release number.
Property ServicePack() As   (Read Only)
Returns the CATIA service pack number.
Parameters:
oServicePack
The CATIA service pack number.
Property Version() As   (Read Only)
Returns the CATIA version number (usually version 5).
Parameters:
oVersion
The CATIA version.
Methods
Sub GetProductNames( ioProductNames)
Returns the product names of all the licenses currently known to the
system.
Parameters:
CATSafeArrayVariant
An properly dimensioned array of strings in which the product names
will be stored.
Example:
This example determines if the first product in the list of
known product names is authorized.
Dim SystemConfiguration1 As SystemConfiguration
Set SystemConfiguration1 = CATIA.SystemConfiguration
ReDim NameArray(SystemConfiguration1.ProductCount)
SystemConfiguration1.GetProductNames NameArray
MsgBox "IsProductAuthorized for product " & NameArray(0) & "  returns " & SystemConfiguration1.IsProductAuthorized(NameArray(0))
Func IsProductAuthorized( iProductName) As
Returns True if the specified product is authorized, False otherwise.
Parameters:
iProductName
The name of the product to check.
oAuthorized
A boolean which specifies if the product is authorized.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_TextStream_16570 ===
InfInterfaces TextStream (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
TextStream (Object)
The textstream object allows to manage input and output
for a text stream.
Property Index
AtEndOfLine
Returns a boolean value which specifies if the
index position in the stream is at a end of line.
AtEndOfStream
Returns a boolean value which specifies if the
index position in the stream is at a end of stream.
Method Index
Close
Closes a text stream.
Read
Returns a string which contains a given number of characters
from the current position in the stream.
ReadLine
Returns a string which contains a line of charaters
from the current position in the stream.
Write
Writes a string  in the text stream.
Properties
Property AtEndOfLine() As   (Read Only)
Returns a boolean value which specifies if the
index position in the stream is at a end of line.
Example:
This example retrieves in EndLine the end of line value
for  the TextStream TestStream.
Dim EndLine As Boolean
EndLine = TestStream.AtEndOfLine
Property AtEndOfStream() As   (Read Only)
Returns a boolean value which specifies if the
index position in the stream is at a end of stream.
Example:
This example retrieves in EndStream the end of stream value
for  the TextStream TestStream.
Dim EndStream As Boolean
EndStream = TestStream.AtEndOfStream
Methods
Sub Close()
Closes a text stream.
Example:
This example closes the TextStream TestStream
TestStream.Close
Func Read( iNumOfChar) As
Returns a string which contains a given number of characters
from the current position in the stream.
Parameters:
iNumOfChar
The number of characters to read.
Returns:
oReadString	 The retrieved string.
Example:
This example retrieves the next fifty characters
of the TextStream TestStream in the
stream ReadString.
Dim ReadString As String
Set ReadString = TestStream.Read(50)
Func ReadLine() As
Returns a string which contains a line of charaters
from the current position in the stream.
Returns:
oReadLine	 The retrieved read line.
Example:
This example retrieves the next line
of the TextStream TestStream in the
stream ReadString.
Dim ReadString As String
Set ReadString = TestStream.ReadLine
Sub Write( iWrittenString)
Writes a string  in the text stream.
Parameters:
iWrittenString
The string to write in the stream.
Example:
This example write a string in the
the TextStream TestStream.
TestStream.Write("This is a test")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_TreeVizManipSettingAtt_35696 ===
InfInterfaces TreeVizManipSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
TreeVizManipSettingAtt (Object)
The Interface to retrieve and set the visual information on the specification tree.
Property Index
ArcSelectionActivation
Retrieves or Sets the arc-selection mode applied to the specification tree.
AutoExpandActivation
Retrieves or Sets the automatic expand mode applied to the specification tree.
AutoScrollActivation
Retrieves or Sets the automatic scrolling mode applied to the specification tree.
DisplayGeomOnScrolling
Retrieves or Sets the "display geometry on scrolling" mode.
Orientation
Retrieves or Sets the orientation applied to the specification tree.
ShowActivation
Retrieves or Sets the visualization Show/NoShow's mode applied to the specification tree.
Size
Retrieves or Sets the number of characters shown for the text of the specification tree.
SizeType
Retrieves or Sets the type of size applied to the text of the specification tree.
Type
Retrieves or Sets the type applied to the specification tree.
Method Index
GetArcSelectionActivationInfo
Retrieves environment informations for arc-selection mode applied to the specification tree.
GetAutoExpandActivationInfo
Retrieves environment informations for automatic expand mode applied to the specification tree.
GetAutoScrollActivationInfo
Retrieves environment informations for automatic scrolling mode applied to the specification tree.
GetDisplayGeomOnScrollingInfo
Retrieves environment informations for "display geometry on scrolling" mode.
GetOrientationInfo
Retrieves environment informations for the orientation applied to the specification tree.
GetShowActivationInfo
Retrieves environment informations for the visualization Show/NoShow's mode applied to the specification tree.
GetSizeTypeInfo
Retrieves environment informations for the type of size applied to the text of the specification tree.
GetTypeInfo
Retrieves environment informations for the type applied to the specification tree.
SetArcSelectionActivationLock
Locks or unlocks the arc-selection mode applied to the specification tree.
SetAutoExpandActivationLock
Locks or unlocks the automatic expand mode applied to the specification tree.
SetAutoScrollActivationLock
Locks or unlocks the automatic scrolling mode applied to the specification tree.
SetDisplayGeomOnScrollingLock
Locks or unlocks the "display geometry on scrolling" mode.
SetOrientationLock
Locks or unlocks the orientation applied to the specification tree.
SetShowActivationLock
Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree.
SetSizeTypeLock
Locks or unlocks the type of size applied to the text of the specification tree.
SetTypeLock
Locks or unlocks the type of the specification tree.
Properties
Property ArcSelectionActivation() As
Retrieves or Sets the arc-selection mode applied to the specification tree.
Property AutoExpandActivation() As
Retrieves or Sets the automatic expand mode applied to the specification tree.
Property AutoScrollActivation() As
Retrieves or Sets the automatic scrolling mode applied to the specification tree.
Property DisplayGeomOnScrolling() As
Retrieves or Sets the "display geometry on scrolling" mode.
Property Orientation() As
Retrieves or Sets the orientation applied to the specification tree.
Property ShowActivation() As
Retrieves or Sets the visualization Show/NoShow's mode applied to the specification tree.
Property Size() As
Retrieves or Sets the number of characters shown for the text of the specification tree.
Property SizeType() As
Retrieves or Sets the type of size applied to the text of the specification tree.
Property Type() As
Retrieves or Sets the type applied to the specification tree.
Methods
Func GetArcSelectionActivationInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for arc-selection mode applied to the specification tree.
Role:Retrieves the state of arc-selection mode applied to the specification tree
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetAutoExpandActivationInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for automatic expand mode applied to the specification tree.
Role:Retrieves the state of automatic expand mode applied to the specification tree
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetAutoScrollActivationInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for automatic scrolling mode applied to the specification tree.
Role:Retrieves the state of the automatic scrolling mode applied to the specification tree
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetDisplayGeomOnScrollingInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for "display geometry on scrolling" mode.
Role:Retrieves the state of "display geometry on scrolling" mode
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetOrientationInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the orientation applied to the specification tree.
Role:Retrieves the state of the orientation applied to the specification tree
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetShowActivationInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the visualization Show/NoShow's mode applied to the specification tree.
Role:Retrieves the state of the visualization Show/NoShow's mode applied to the specification tree
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetSizeTypeInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the type of size applied to the text of the specification tree.
Role:Retrieves the state of the type of size applied to the text of the specification tree
in the current environment.
Attributes "size" and "SizeType" are linked together by the same
lock. So there is no function "GetSizeInfo".
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetTypeInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the type applied to the specification tree.
Role:Retrieves the state of the type applied to the specification tree
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub SetArcSelectionActivationLock( iLocked)
Locks or unlocks the arc-selection mode applied to the specification tree.
Role:Locks or unlocks the arc-selection mode applied to the specification tree 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.
Sub SetAutoExpandActivationLock( iLocked)
Locks or unlocks the automatic expand mode applied to the specification tree.
Role:Locks or unlocks the automatic expand mode applied to the specification tree 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.
Sub SetAutoScrollActivationLock( iLocked)
Locks or unlocks the automatic scrolling mode applied to the specification tree.
Role:Locks or unlocks the automatic scrolling mode applied to the specification tree 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.
Sub SetDisplayGeomOnScrollingLock( iLocked)
Locks or unlocks the "display geometry on scrolling" mode.
Role:Locks or unlocks "display geometry on scrolling" mode 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.
Sub SetOrientationLock( iLocked)
Locks or unlocks the orientation applied to the specification tree.
Role:Locks or unlocks the orientation applied to the specification tree 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.
Sub SetShowActivationLock( iLocked)
Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree.
Role:Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree 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.
Sub SetSizeTypeLock( iLocked)
Locks or unlocks the type of size applied to the text of the specification tree.
Role:Locks or unlocks the type of size applied to the text of the specification tree if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Attributs "size" and "SizeType" are linked together by the same
lock. So there is no function "SetSizeTypeLock".
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetTypeLock( iLocked)
Locks or unlocks the type of the specification tree.
Role:Locks or unlocks the type applied to the specification tree 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.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Viewer2D_14235 ===
InfInterfaces Viewer2D (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Viewer2D (Object)
Represents a 2D viewer.
The 2D viewer aggregates a 2D viewpoint to display a 2D scene.
Property Index
Viewpoint2D
Returns or sets the 2D viewpoint of a 2D viewer.
Properties
Property Viewpoint2D() As
Returns or sets the 2D viewpoint of a 2D viewer.
Example:
This example retrieves the Nice2DViewpoint 2D viewpoint from
the My2DViewer 2D viewer.
Dim Nice2DViewpoint As Viewpoint2D
Set Nice2DViewpoint = My2DViewer.Viewpoint2D
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Viewer3D_14241 ===
InfInterfaces Viewer3D (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Viewer3D (Object)
Represents a 3D viewer.
The 3D viewer aggregates a 3D viewpoint to display a 3D scene.
In addition, the Viewer3D object manages the lighting, the depth effects,
the navigation style, and the rendering mode.
See also:
, , ,
Property Index
ClippingMode
Returns or sets the clipping mode.
FarLimit
Returns or sets the far limit for the far clipping plane.
Foggy
Returns or sets the fog mode.
Ground
Returns or sets the ground displaying mode.
LightSources
Returns the viewer's light source collection.
LightingIntensity
Returns or sets the lighting intensity.
LightingMode
Returns or sets the lighting mode.
NavigationStyle
Returns or sets the navigation style.
NearLimit
Returns or sets the near limit for the near clipping plane.
RenderingMode
Returns or sets the rendering mode.
Viewpoint3D
Returns or sets the 3D viewpoint of a 3D viewer.
Method Index
Rotate
Applies a rotation.
Translate
Applies a translation.
Properties
Property ClippingMode() As
Returns or sets the clipping mode.
Example:
This example sets the depth effect for the
My3DViewer 3D viewer to catClippingModeNearAndFar.
My3DViewer.ClippingMode = catClippingModeNearAndFar
Property FarLimit() As
Returns or sets the far limit for the far clipping plane.
The distance is measured from the eye location, that is the origin of
the viewpoint, and is expressed in model unit.
The far clipping plane is available with the catClippingModeFar
and catClippingModeNearAndFar values of the
enumeration only.
Example:
This example sets the far limit for the far clipping plane of the
My3DViewer 3D viewer to 150 model units.
My3DViewer.FarLimit = 150
Property Foggy() As
Returns or sets the fog mode. Useful when clipping is enabled.
Example:
This example sets the fog on for the
My3DViewer 3D viewer:
My3DViewer.Foggy = True
Property Ground() As
Returns or sets the ground displaying mode.
Example:
This example makes the ground visible for the
My3DViewer 3D viewer:
My3DViewer.Ground = True
Property LightSources() As   (Read Only)
Returns the viewer's light source collection.
Example:
This example retrieves the light source collection for the
My3DViewer 3D viewer in VPLightSources.
Set VPLightSources = My3DViewer.LightSources
Property LightingIntensity() As
Returns or sets the lighting intensity.
The lighting intensity ranges between 0 and 1.
Example:
This example sets the lighting intensity for the My3DViewer
3D viewer to 0.35.
My3DViewer.LightingIntensity = 0.35
Property LightingMode() As
Returns or sets the lighting mode.
Example:
This example sets the lighting mode for the My3DViewer
3D viewer to catInfiniteLightSource.
My3DViewer.LightingMode = catInfiniteLightSource
Property NavigationStyle() As
Returns or sets the navigation style.
Example:
This example sets the navigation style for the My3DViewer
3D viewer to catNavigationWalk.
My3DViewer.NavigationStyle = catNavigationWalk
Property NearLimit() As
Returns or sets the near limit for the near clipping plane.
The distance is measured from the eye location, that is the origin of
the viewpoint, and is expressed in model unit.
The near clipping plane is available with the catClippingModeNear
and catClippingModeNearAndFar values of the
enumeration only.
Example:
This example sets the near limit for the near clipping plane of the
My3DViewer 3D viewer to 75 model units.
My3DViewer.NearLimit = 75
Property RenderingMode() As
Returns or sets the rendering mode.
Example:
This example sets the rendering mode for the My3DViewer
3D viewer to catRenderShadingWithEdges.
My3DViewer.RenderingMode = catRenderShadingWithEdges
Property Viewpoint3D() As
Returns or sets the 3D viewpoint of a 3D viewer.
Example:
This example retrieves the Nice3DViewpoint 3D viewpoint from
the My3DViewer 3D viewer.
Dim Nice3DViewpoint As Viewpoint3D
Set Nice3DViewpoint = My3DViewer.Viewpoint3D
Methods
Sub Rotate( iAxis, iAngle)
Applies a rotation.
The rotation of iAngle degrees is applied to the viewer's contents
around the axis iAxis (an array of 3 Variants), the invariant
point being the target (ie: Origin + FocusDistance*SightDirection).
Example:
This applies a rotation of 10 degrees around the Up Direction to
the contents of the MyViewer3D viewer.
MyViewer3D.Rotate MyViewer3D.UpDirection, 10
Sub Translate( iVector)
Applies a translation.
The translation vector is iVector (an array of 3 Variants).
Example:
This applies a translation along (1, 1, 1) to
the contents of the MyViewer3D viewer.
MyViewer3D.Translate Array(1, 1, 1)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Viewer_13459 ===
InfInterfaces Viewer (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Viewer (Object)
Represents the viewer.
The viewer is the object that makes your objects display on the screen.
Property Index
FullScreen
Returns or sets the state of a viewer to occupy the whole screen.
Height
Returns the viewer's height, in pixels.
Width
Returns the viewer's width, in pixels.
Method Index
Activate
Activates the viewer in the window.
CaptureToFile
Captures the actually displayed scene by the viewer as an image,
and stores the image in a file.
GetBackgroundColor
Gets the viewer's background color.
NewCamera
Creates a new camera from the viewpoint of the viewer.
PutBackgroundColor
Sets the viewer's background color.
Reframe
Reframes the viewer's contents (Fits all in).
Update
Updates the viewer's contents.
ZoomIn
Zooms in the viewer's contents.
ZoomOut
Zooms out the viewer's contents.
Properties
Property FullScreen() As
Returns or sets the state of a viewer to occupy the whole screen.
True if the viewer occupies the whole screen.
Example:
This example retrieves in IsFullScreen whether the
MyViewer viewer occupies the whole screen.
IsFullScreen = MyViewer.FullScreen
Property Height() As   (Read Only)
Returns the viewer's height, in pixels.
Example:
This example retrieves the height of the MyViewer viewer.
h = MyViewer.Height
Property Width() As   (Read Only)
Returns the viewer's width, in pixels.
Example:
This example retrieves the width of the MyViewer viewer.
w = MyViewer.Width
Methods
Sub Activate()
Activates the viewer in the window.
Example:
This example activates Viewers(1) in the window MyWindow.
MyWindow.Viewers(1).Activate()
Sub CaptureToFile( iFormat, iFile)
Captures the actually displayed scene by the viewer as an image,
and stores the image in a file.
Clipped parts of the scene are also clipped in the captured image.
Images can be captured as CGM, EMF, TIFF, TIFF Greyscale,
BMP, and JPEG images.
Parameters:
iFormat
The format in which the image will be created
iFile
The full pathname of the file into which you want to store the
captured image
Example:
This example captures the displayed part of the
MyViewer viewer as a BMP image, and stores it in the
e:\MyImage.bmp file.
MyViewer.CaptureToFile catCaptureFormatBMP, "e:\MyImage.bmp"
Sub GetBackgroundColor( color)
Gets the viewer's background color.
The color is expressed in the RGB color mode, as a triplet of coordinates
ranging from 0 to 1 for the red, green, and blue colors respectively.
Example:
This example gets the background color of the MyViewer viewer.
Dim color(2)
MyViewer.GetBackgroundColor color
Func NewCamera() As
Creates a new camera from the viewpoint of the viewer.
Example:
This example creates the MyCamera new camera by using the
current viewpoint of the MyViewer viewer.
Dim MyCamera As Camera
Set MyCamera = MyViewer.NewCamera()
Sub PutBackgroundColor( color)
Sets the viewer's background color.
The color is expressed in the RGB color mode, as a triplet of coordinates
ranging from 0 to 1 for the red, green, and blue colors respectively.
Example:
This example sets the background color of the MyViewer viewer
to blue, that is the color with (0.,0.,1.) coordinates
MyViewer.PutBackgroundColor Array(0, 0, 1)
Sub Reframe()
Reframes the viewer's contents (Fits all in).
Reframing means that the viewer's contents is zoomed in or out to
enable every object of the scene to be displayed in such a way that
most of the space available in the viewer is used, just leaving a thin
empty strip around the scene.
Example:
This example reframes the contents of the MyViewer viewer.
MyViewer.Reframe()
Sub Update()
Updates the viewer's contents.
Since the viewer is not automatically updated after a viewpoint
modification (for performance reasons), it must be
explicitely redrawn when needed.
Example:
This example updates the contents of the MyViewer viewer.
MyViewer.Update()
Sub ZoomIn()
Zooms in the viewer's contents.
Example:
This example zooms in the contents of the MyViewer viewer.
MyViewer.ZoomIn()
Sub ZoomOut()
Zooms out the viewer's contents.
Example:
This example zooms out the contents of the MyViewer viewer.
MyViewer.ZoomOut()
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Viewers_14149 ===
InfInterfaces Viewers (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Viewers (Object)
A collection of all the Viewer objects currently attached to a
window.
For a  object, the viewer containing the geometry is the first viewer, and the viewer containing the specification
tree is the second viewer.
Method Index
Item
Returns a viewer using its index from the Viewers collection.
Methods
Func Item( iIndex) As
Returns a viewer using its index from the Viewers collection.
The first item has the rank 1 in the collection.
Parameters:
iIndex
The index or the name of the viewer to retrieve from
the collection of viewers.
As a numerics, this index is the rank of the viewer
in the collection.
The index of the first viewer in the collection is 1, and
the index of the last viewer is Count.
As a string, it is the name you assigned to the viewer using
the
property.
Returns:
The retrieved viewer
Example:
This example returns in MyViewer the second viewer
in the collection.
Dim MyViewer As Viewer
Set MyViewer = Viewer.Item(2)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Viewpoint2D_16946 ===
InfInterfaces Viewpoint2D (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Viewpoint2D (Object)
Represents the 2D viewpoint.
The 2D viewpoint is the object that stores data which defines how your
objects are seen to enable their display by a 2D viewer.
This data includes namely the origin of the scene,
that is the center of the displayed area, and the zoom factor.
Property Index
Zoom
Returns or sets the zoom factor associated with the viewpoint.
Method Index
GetOrigin
Gets the coordinates of the origin of the viewpoint.
PutOrigin
Sets the coordinates of the origin of the viewpoint.
Properties
Property Zoom() As
Returns or sets the zoom factor associated with the viewpoint.
Example:
This example retrieves in ZoomFactor the zoom factor associated
with the NiceViewpoint viewpoint, tests if it is less than 1,
and if so, sets it to one and applies it to the viewpoint.
ZoomFactor = NiceViewpoint.Zoom
If ZoomFactor < 1 Then
ZoomFactor = 1
NiceViewpoint.Zoom(ZoomFactor)
End If
Methods
Sub GetOrigin( oOrigin)
Gets the coordinates of the origin of the viewpoint.
Example:
This example Gets the origin of the NiceViewpoint viewpoint.
Dim origin(1)
NiceViewpoint.GetOrigin origin
Sub PutOrigin( oOrigin)
Sets the coordinates of the origin of the viewpoint.
Example:
This example sets the origin of the NiceViewpoint viewpoint
to the point with coordinates (5, 8).
NiceViewpoint.PutOrigin Array(5, 8)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Viewpoint3D_16955 ===
InfInterfaces Viewpoint3D (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Viewpoint3D (Object)
Represents the 3D viewpoint.
The 3D viewpoint is the object that stores data which defines how your
objects are seen to enable their display by a 3D viewer.
This data includes namely the eye location, also named the origin,
the distance from the eye to the target, that is to the looked at point
in the scene,
the sight, up, and right directions, defining a 3D axis system with
the eye location as origin, the projection type chosen among
perspective (conic) and parallel (cylindric),
and the zoom factor.
The right direction is not exposed in a property, and is automatically
computed from the sight and up directions.
See also:
Property Index
FieldOfView
Returns or sets the field of view associated with the viewpoint.
FocusDistance
Returns or sets the focus distance of the viewpoint.
ProjectionMode
Returns or sets the projection mode.
Zoom
Returns or sets the zoom factor associated with the viewpoint.
Method Index
GetOrigin
Retrieves the coordinates of the origin of the viewpoint.
GetSightDirection
Gets the components of the sight direction of the viewpoint.
GetUpDirection
Gets the components of the up direction of the viewpoint.
PutOrigin
Sets the coordinates of the origin of the viewpoint.
PutSightDirection
Sets the components of the sight direction of the viewpoint.
PutUpDirection
Sets the components of the up direction of the viewpoint.
Properties
Property FieldOfView() As
Returns or sets the field of view associated with the viewpoint.
The field of view is half of the vertical angle of the viewpoint,
expressed in degrees.
This property exists with the perspective (conic) projection type only.
Example:
This example retrieves in HalfAngle the field of view
associated with the NiceViewpoint viewpoint.
HalfAngle = NiceViewpoint.FieldOfView
Property FocusDistance() As
Returns or sets the focus distance of the viewpoint.
The focus distance determines the target position, that is
the point at which the eye located at the origin and looking towards
the sight direction is looking at. It is expressed in model units.
Example:
This example sets the focus distance of the NiceViewpoint
viewpoint to 10.
NiceViewpoint.FocusDistance = 10
Property ProjectionMode() As
Returns or sets the projection mode.
Example:
This example sets the projection mode for the My3DViewer
3D viewer to catProjectionConic.
My3DViewer.Viewpoint3D.NavigationStyle = catProjectionConic
Property Zoom() As
Returns or sets the zoom factor associated with the viewpoint.
This property exists with the parallel (cylindric) projection type only.
Example:
This example retrieves in ZoomFactor the zoom factor associated
with the NiceViewpoint viewpoint, tests if it is greater than 2,
and if so, sets it to one and applies it.
ZoomFactor = NiceViewpoint.Zoom
If ZoomFactor > 2 Then
ZoomFactor = 1
NiceViewpoint.Zoom(ZoomFactor)
End If
Methods
Sub GetOrigin( origin)
Retrieves the coordinates of the origin of the viewpoint.
These coordinates are returned as an array of 3 Variants (double type).
Example:
This example retrieves the origin of the NiceViewpoint viewpoint
in the origin variable.
Dim origin(2)
NiceViewpoint.GetOrigin origin
Sub GetSightDirection( oSight)
Gets the components of the sight direction of the viewpoint.
The sight direction is the line passes both by the origin of the viewpoint
and by the target.
Example:
This example gets the sight direction of the NiceViewpoint
Dim sight(2)
NiceViewpoint.GetSightDirection sight
Sub GetUpDirection( oUp)
Gets the components of the up direction of the viewpoint.
Example:
This example gets the up direction of the NiceViewpoint.
Dim up(2)
NiceViewpoint.GetUpDirection up
Sub PutOrigin( origin)
Sets the coordinates of the origin of the viewpoint.
These coordinates are set as an array of 3 Variants (double type).
Example:
This example sets the origin of the NiceViewpoint viewpoint.
to the point with coordinates (10, 25, 15).
NiceViewpoint.PutOrigin Array(10, 25, 15)
Sub PutSightDirection( oSight)
Sets the components of the sight direction of the viewpoint.
The sight direction is the line passes both by the origin of the viewpoint
and by the target.
Example:
This example sets the sight direction of the NiceViewpoint
viewpoint to the direction with components (1.414, 1.414, 0).
NiceViewpoint.PutSightDirection Array(1.414, 1.414, 0)
Sub PutUpDirection( oUp)
Sets the components of the up direction of the viewpoint.
Example:
This example sets the up direction of the NiceViewpoint
viewpoint to the direction with components (0, 0, 1).
NiceViewpoint.PutUpDirection Array(0, 0, 1)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_VisPropertySet_21585 ===
InfInterfaces VisPropertySet (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
VisPropertySet (Object)
Represents the graphic properties for the current selection.
Role: We retrieve the graphic properties of the current selection
thanks to
The graphic properties are:
The Color
The Color is defined by 3 components (red,green,blue). Each component ranges from 0 to 255
The Opacity
The opacity is defined from 255 (total opacity) to 0 (total transparency).
In Material visualization mode the transparency is real, so the element
is truly  more or less opaque. But in another visualization mode, the transparency is a
simulation, so if the opacity is between 0 and 254 the element is transparent but with the same
visual effect and if the opacity is 255 the element is opaque.
The width of a line
Each index defines a width  customizable in Tools/Options.
The type of a line
Solid, Dashed, ...
The symbol of a point
Star, Dot, ...
A partial modification of an object
A part (for example) contains faces, edges, lines, points. Interactively with the Edit
Properties command the end user can change their color, their line type and so one. To
go faster there is the Graphic Toolbar which contains a sub-set of properties.
So this interface follows the behavior of the graphic toolbar. The color, the line type ...
is applicated to the sub-element of the object defined by the application, and that you can
retrieve in the graphic toolbar.
A multiple selection
When we modify a graphic property using the Setxxx methods, we modify
one by one each element of the current selection.
When we read a graphic property using the Getxxx methods, we retrieve an information
which is valid for all elements of the current selection.
Real versus Visible graphic properties
Elements of the current selection are inside a specification tree:
Example :
Product0
Part1
Part3
Part2
In this sample, product0 and Part1 are nodes and Part3 and Part2 are leaves.
Each element (node and leaf) of this tree has its own graphic properties: that is
the "Real" graphic properties.
But there is an inheritance mecanism, so each element has also "Visible"
graphic properties. An element can be displayed with an another graphic properties that
its real graphic properties.
The inheritance is the following:
From the root of the tree, the first node with
an inheritance flag to 1, gives its property to each element below it.
For each graphic property there is an independantly inheritance.
Example with the color property: ( color inheritance flag, color)
Product0    (1,red)
Part1    (0,blue)
Part3   (1,green)
Part2    (0,Yellow)
In this sample the real colord of the product0 is red, blue for the part1,
green for the part3 and yellow for the part2. But the visible color of each element
is red, because the product0 gives the red color at all the tree.
See also:
Method Index
GetLayer
Returns the layer for the current selection.
GetPick
Returns the state pick mode for the current selection.
GetRealColor
Retrieves the real color for the current selection.
GetRealInheritance
Retrieves the real inheritance flag for the current selection.
GetRealLineType
Retrieves the real line type for the current selection.
GetRealOpacity
Retrieves the real opacity for the current selection.
GetRealWidth
Retrieves the real line width for the current selection.
GetShow
Returns the state show mode for the current selection.
GetSymbolType
Retrieves the symbol type for the current selection.
GetVisibleColor
Retrieves the displayed (visible) color for the current selection.
GetVisibleInheritance
Checks if the real property is hidden.
GetVisibleLineType
Retrieves the displayed (visible) line type for the current selection.
GetVisibleOpacity
Retrieves the displayed (visible) opacity for the current selection.
GetVisibleWidth
Retrieves the displayed (visible) line width for the current selection.
SetLayer
Sets the layer for the current selection.
SetPick
Sets the state pick mode for the current selection.
SetRealColor
Sets the real color and the color inheritance flag for the current selection.
SetRealLineType
Sets the real line type and the line type inheritance flag for the current selection.
SetRealOpacity
Sets the opacity and the opacity inheritance flag for the current selection.
SetRealWidth
Sets the real line width and the line width inheritance flag for the current selection.
SetShow
Sets the state show mode for the current selection.
SetSymbolType
Sets the symbol type.
Methods
Func GetLayer( oLayerType, oLayerValue) As
Returns the layer for the current selection.
Note: This property is global for the object.
Parameters:
oLayerType
the type of the layer
When the type is equal to catVisLayerNone, the layer of the current selection is "none".
When the type is equal to catVisLayerBasic, the layer of the currection selection is indicated by the following parameter.
oLayerValue
A value between 0 to 1000
This parameter is usefull only when the type of the layer is catVisLayerBasic.
Example:
The following sample shows how to retrieve layer of current selection.
Dim layer
layer = CLng(0)
Dim layertype As CatVisLayerType
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetLayer layertype, layer
If (layertype = catVisLayerNone) Then
MsgBox "Layer None"
End If
If (layertype = catVisLayerBasic) Then
MsgBox "layer =" & layer
End If
Func GetPick( oPick) As
Returns the state pick mode for the current selection.
Note: This property is global for the object.
Example:
The following sample shows how to retrieve pick mode of current selection.
Dim pickstate As CatVisPropertyPick
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetPick pickstate
MsgBox "pick = " & pickstate
Func GetRealColor( oRed, oGreen, oBlue) As
Retrieves the real color for the current selection.
Parameters:
oRed
A value between 0 and 255
oGreen
A value between 0 and 255
oBlue
A value between 0 and 255
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same real color, so
oRed, oGreen and oBlue are valid
catVisPropertyUnDefined
The real color is not the same for all elements of the current selection, so
oRed, oGreen and oBlue are not valid
Example:
The following sample shows how to retrieve real colors of current selection.
Dim r, g, b
r = CLng(0)
g = CLng(0)
b = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetRealColor r, g, b
MsgBox "r = " & r & " g = " & g & " b = " & b
Func GetRealInheritance( iPropertyType, oInheritance) As
Retrieves the real inheritance flag for the current selection.
Parameters:
iPropertyType
The type of property: Color, Opacity, Line Width, Line Type
oInheritance
0
No heritance
1
Heritance
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same real inheritance flag
for the iPropertyType , so oInheritance is valid
catVisPropertyUnDefined
The real inheritance flag for iPropertyType is not the same for all elements of the current selection,
so oInheritance is not valid
Example:
The following sample shows how to retrieve inheritance of current selection.
Dim inhLineType, inhWidth, inhColor, inhOpacity
inhLineType = CLng(0)
inhWidth = CLng(0)
inhColor = CLng(0)
inhOpacity = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetRealInheritance catVisPropertyLineType, inhLineType
visProperties1.GetRealInheritance catVisPropertyWidth, inhWidth
visProperties1.GetRealInheritance catVisPropertyColor, inhColor
visProperties1.GetRealInheritance catVisPropertyOpacity, inhOpacity
MsgBox "Inheritance : linetype = " & inhLineType & "width =" & inhWidth & "Colour ="  & inhColor & "Opacity =" & inhOpacity
Func GetRealLineType( oLineType) As
Retrieves the real line type for the current selection.
Parameters:
oLineType
The value ranges from 1 to 63. Each indice is a line type customizable in
the page Tools/Options/General/Display/Line Type.
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same real line type , so
oLineType is valid
catVisPropertyUnDefined
The real line type is not the same for all elements of the current selection,
so oLineType is not valid
catVisProperty?
At least one element of the current selection is not concerned by
this property, so oLineType is not valid
Example:
The following sample shows how to retrieve real line type of current selection.
Dim linetype
linetype = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetRealLineType linetype
MsgBox "linetype = " & linetype
Func GetRealOpacity( oOpacity) As
Retrieves the real opacity for the current selection.
Parameters:
oOpacity
a value between 0 (total transparency) and 255 (total opacity)
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same real opacity value, so
oOpacity is valid
catVisPropertyUnDefined
The real opacity value is not the same for all elements of the current selection, so
oOpacity is not valid
catVisProperty?
At least one element of the current selection is not concerned by
this property, so oOpacity is not valid
Example:
The following sample shows how to retrieve real opacity of current selection.
Dim op
op = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetRealOpacity op
MsgBox "opacity = " & op
Func GetRealWidth( oLineWidth) As
Retrieves the real line width for the current selection.
Parameters:
oLineWidth
The value ranges from 1 to 63. Each indice is a thickness customizable in
the page Tools/Options/General/Display/thickness.
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same real width , so
oLineWidth is valid
catVisPropertyUnDefined
The real width is not the same for all elements of the current selection,
so oLineWidth is not valid
catVisProperty?
At least one element of the current selection is not concerned by
this property, so oLineWidth is not valid
Example:
The following sample shows how to retrieve real line width of current selection.
Dim width
width = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetRealWidth width
MsgBox "width = " & width
Func GetShow( oShow) As
Returns the state show mode for the current selection.
Note: This property is global for the object.
Example:
The following sample shows how to retrieve show mode of current selection.
Dim showstate As CatVisPropertyShow
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetShow showstate
MsgBox "show = " & showstate
Func GetSymbolType( oSymbolType) As
Retrieves the symbol type for the current selection.
Parameters:
oSymbolType
The symbol type. See
to have values.
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same symbol type , so
oLineType is valid
catVisPropertiesUnDefined
The symbol type is not the same for all elements of the current selection,
so oLineType is not valid
catVisProperty?
At least one element of the current selection is not concerned by
this property, so oSymbolType is not valid
Example:
The following sample shows how to retrieve symbol line type of current selection.
Dim symbol
symbol = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetSymbolType symbol
MsgBox "Symbol = " & symbol
Func GetVisibleColor( oRed, oGreen, oBlue) As
Retrieves the displayed (visible) color for the current selection.
Parameters:
oRed
a value between 0 and 255
oGreen
a value between 0 and 255
oBlue
a value between 0 and 255
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same visible color, so
oRed, oGreen and oBlue are valid
catVisPropertyUnDefined
The visible color is not the same for all elements of the current selection, so
oRed, oGreen and oBlue are not valid
Example:
The following sample shows how to retrieve displayed colors of current selection.
Dim r, g, b
r = CLng(0)
g = CLng(0)
b = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetVisibleColor r, g, b
MsgBox "r = " & r & " g = " & g & " b = " & b
Func GetVisibleInheritance( iPropertyType, oInheritance) As
Checks if the real property is hidden.
Parameters:
iPropertyType
The type of property : Color, Opacity, Line Width, Line Type
oInheritance
0
No heritance: All parents of each element of the current selection have an inheritance
flag to 0.
1
Heritance: one parent of each element, perhaps the element itself, as a inheritance
flag to 1.
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same inheritance flag
for the iPropertyType , so oInheritance is valid
catVisPropertyUnDefined
The inheritance flag for iPropertyType is not the same for all elements of the current selection,
so oInheritance is not valid
Func GetVisibleLineType( oLineType) As
Retrieves the displayed (visible) line type for the current selection.
Parameters:
oLineType
A value ranges from 1 to 63.
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same visible line type , so
oLineType is valid
catVisPropertyUnDefined
The visible line type is not the same for all elements of the current selection,
so oLineType is not valid
catVisProperty?
At least one element of the current selection is not concerned by
this property, so oLineType is not valid
Example:
The following sample shows how to retrieve displayed line type of current selection.
Dim linetype
linetype = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetVisibleLineType linetype
MsgBox "linetype = " & linetype
Func GetVisibleOpacity( oOpacity) As
Retrieves the displayed (visible) opacity for the current selection.
Parameters:
oOpacity
a value between 0 (total transparency) and 255 (total opacity)
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same visible opacity value, so
oOpacity is valid
catVisPropertyUnDefined
The visible opacity value is not the same for all elements of the current selection, so
oOpacity is not valid
catVisProperty?
At least one element of the current selection is not concerned by
this property, so oOpacity is not valid
Example:
The following sample shows how to retrieve displayed opacity of current selection.
Dim op
op = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetVisibleOpacity op
MsgBox "opacity = " & op
Func GetVisibleWidth( oLineWidth) As
Retrieves the displayed (visible) line width for the current selection.
Parameters:
oLineWidth
A value ranges from 1 to 63.
oStatus
Legal value:
catVisPropertyDefined
All elements in the current selection have the same visible width , so
oLineWidth is valid
catVisPropertyUnDefined
The visible width is not the same for all elements of the current selection,
so oLineWidth is not valid
catVisProperty?
At least one element of the current selection is not concerned by
this property, so oLineWidth is not valid
Example:
The following sample shows how to retrieve displayed line width of current selection.
Dim width
width = CLng(0)
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.GetVisibleWidth width
MsgBox "width = " & width
Sub SetLayer( iLayerType, iLayerValue)
Sets the layer for the current selection.
Note: This property is global for the object.
Parameters:
iLayerType
the type of the layer
iLayerValue
A value between 0 to 1000
This parameter is used only when the type of the layer is catVisLayerBasic.
Example:
The following sample shows how to change layer of current selection.
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.SetLayer catVisLayerBasic, 100
Sub SetPick( iPick)
Sets the state pick mode for the current selection.
Note: This property is global for the object.
Example:
The following sample shows how to change pick mode of current selection.
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.SetPick catVisPropertyNoPickAttr
Sub SetRealColor( iRed, iGreen, iBlue, iInheritance)
Sets the real color and the color inheritance flag for the current selection.
Parameters:
iRed
A value between 0 and 255
iGreen
A value between 0 and 255
iBlue
A value between 0 and 255
iInheritance
Legal value:
0
No heritance
1
Heritance
Example:
The following sample shows how to change colour of current selection.
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.SetRealColor 255,0,0,1
Sub SetRealLineType( iLineType, iInheritance)
Sets the real line type and the line type inheritance flag for the current selection.
Parameters:
iLineType
The value ranges from 1 to 63. Each indice is a line type customizable in
the page Tools/Options/General/Display/Line Type.
iInheritance
Legal value:
0
No heritance
1
Heritance
Example:
The following sample shows how to change line type of current selection.
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.SetRealLineType 4,1
Sub SetRealOpacity( iOpacity, iInheritance)
Sets the opacity and the opacity inheritance flag for the current selection.
Parameters:
iOpacity
A value between 0 (total transparency) and 255 (total opacity).
iInheritance
Legal value:
0
No heritance
Example:
The following sample shows how to change opacity of current selection.
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.SetRealOpacity 128,1
Sub SetRealWidth( iLineWidth, iInheritance)
Sets the real line width and the line width inheritance flag for the current selection.
Parameters:
iLineWidth
The value ranges from 1 to 63. Each indice is a thickness customizable in
the page Tools/Options/General/Display/thickness.
iInheritance
Legal value:
0
No heritance
1
Heritance
Example:
The following sample shows how to change line width of current selection.
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.SetRealWidth 4,1
Sub SetShow( iShow)
Sets the state show mode for the current selection.
Note: This property is global for the object.
Example:
The following sample shows how to change show mode of current selection.
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.SetShow catVisPropertyNoShowAttr
Sub SetSymbolType( iSymbolType)
Sets the symbol type.
Note:There is no heritage for symbols. That is why there is only one function
"SetSymbolType"  and no function "SetRealSymbolType" or "SetVisibleSymbolType"
Parameters:
iSymbolType
The symbol type
legal values:
1 : a cross which looks like a "X".
2 : a cross which looks like a "+"
3 : an unfilled circle
4 : two unfilled concentric circles
5 : a filled circle
6 : a filled square
7 : a star which is the union of a 2D marker CROSS ,a 2D marker PLUS and a 2D marker DOT
8 : a dot
9 : a smalldot (one pixel)
10 : a kind of arrow which points to the bottom-left
/
|  /
|/__
11 : a kind of arrow which points to the top-rigth
___
/|
/  |
/
FULLCIRCLE2 : a big 12
FULLSQUARE2 : a big 13
Example:
The following sample shows how to change symbol type of current selection.
Set visProperties1 = CATIA.ActiveDocument.Selection.VisProperties
visProperties1.SetSymbolType 4
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_VisualizationSettingAtt_38429 ===
InfInterfaces VisualizationSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
VisualizationSettingAtt (Object)
The interface to access a CATIAVisualizationSettingAtt.
Property Index
AccuratePickingMode
Returns the AccuratePickingMode parameter.
AccuratePickingWindowSize
Returns the AccuratePickingWindowSize parameter.
AllZBufferElementMode
Returns the AllZBufferElementMode parameter.
AmbientActivation
Returns the AmbientActivation parameter.
AntiAliasingMode
Returns the AntiAliasingMode parameter.
AntiAliasingOffset
Returns the AntiAliasingOffset parameter.
AuxiliaryDrillViewer
Returns the AuxiliaryDrillViewer parameter.
BackFaceCullingMode
BorderEdgesMode
Returns the BorderEdgesMode parameter.
BorderEdgesThickness
Returns the BorderEdgesThickness parameter.
BoundingBoxSelectionMode
Returns the BoundingBoxSelectionMode parameter.
ColorBackgroundMode
Returns the ColorBackgroundMode parameter.
DefaultDiffuseAmbientCoefficient
Returns the AmbientActivation parameter.
DefaultShininess
Returns the AmbientActivation parameter.
DefaultSpecularCoefficient
Returns the AmbientActivation parameter.
DisplayCurrentScale
Returns the SetStereoModeLock parameter.
DisplayDrillList
Returns the DisplayDrillList parameter.
DisplayImmersiveDrillViewer
Returns the DisplayImmersiveDrillViewer parameter.
DynamicCull
Returns the DynamicCull parameter.
DynamicLOD
Returns the DynamicLOD parameter.
FaceHLDrill
Returns the FaceHLDrill parameter.
FlyCollisionMode
Returns the FlyCollisionMode parameter.
FlyCollisionSphereRadius
Returns the FlyCollisionSphereRadius parameter.
FlyCollisionType
Returns the FlyCollisionType parameter.
FlySensitivity
Returns the FlySensitivity parameter.
FlySpeed
Returns the FlySpeed parameter.
FlySpeedMode
Returns the FlySpeedMode parameter.
FollowGroundAltitude
Returns the FollowGroundAltitude parameter.
FollowGroundMode
Returns the FollowGroundMode parameter.
FullSceneAntiAliasingMode
Returns the AntiAliasingMode parameter.
Gravity
Returns the Gravity parameter.
GravityAxis
Returns the GravityAxis parameter.
HaloMode
Returns the HaloMode parameter.
IsoparGenerationMode
Returns the IsoparGenerationMode parameter.
KeyboardRotationAngleValue
Retrieves the angle value for rotations operated through key combinations.
LightViewerMode
Returns the LightViewerMode parameter.
LineicCgrMode
Returns the LineicCgrMode parameter.
MaxSelectionMove
Returns the MaxSelectionMove parameter.
MinimumFPSMode
Returns the MinimumFPSMode parameter.
MinimumSpaceFPSMode
Returns the MinimumSpaceFPSMode parameter.
MouseDoubleClicDelay
Returns the MouseDoubleClicDelay parameter.
MouseSpeedValue
Returns the MouseSpeedValue parameter.
NbIsopars
Returns the NbIsopars parameter.
NoZBufferSelectionMode
Returns the NoZBufferSelectionMode parameter.
NumberOfMinimumFPS
Returns the NumberOfMinimumFPS parameter.
NumberOfMinimumSpaceFPS
Returns the NumberOfMinimumSpaceFPS parameter.
OcclusionCullingMode
Returns the OcclusionCullingMode parameter.
OpaqueFaces
Returns the SetStereoModeLock parameter.
OtherSelectionTimeout
Returns the OtherSelectionTimeout parameter.
OtherSelectionTimeoutActivity
Returns the OtherSelectionTimeoutActivity parameter.
PickingWindowSize
Returns the PickingWindowSize parameter.
PreSelNavigatorStartedByArrowKeys
Returns the PreSelNavigatorStartedByArrowKeys parameter.
PreSelectionMode
Returns the PreSelectionMode parameter.
PreselectedElementLinetype
Returns the PreselectedElementLinetype parameter.
RotationSphereMode
Returns the RotationSphereMode parameter.
ShaderMode
Returns the ShaderMode parameter.
StaticCull
Returns the StaticCull parameter.
StaticLOD
Returns the StaticLOD parameter.
StereoMode
Returns the StereoMode parameter.
TransparencyMode
Returns the TransparencyMode parameter.
TwoSideLightingMode
Returns the TwoSideLightingMode parameter.
ViewpointAnimationMode
Returns the ViewpointAnimationMode parameter.
Viz2DAccuracyMode
Returns the 2DAccuracyMode parameter.
Viz2DFixedAccuracy
Returns the 2DFixedAccuracy parameter.
Viz2DProportionnalAccuracy
Returns the 2DProportionnalAccuracy parameter.
Viz3DAccuracyMode
Returns the Viz3DAccuracyMode parameter.
Viz3DCurveAccuracy
Returns the 3DCurveAccuracy parameter.
Viz3DFixedAccuracy
Returns the 3DFixedAccuracy parameter.
Viz3DProportionnalAccuracy
Returns the Viz3DProportionnalAccuracy parameter.
Method Index
GetAccuratePickingModeInfo
Retrieves information about the AccuratePickingMode setting parameter.
GetAccuratePickingWindowSizeInfo
Retrieves information about the AccuratePickingWindowSize setting parameter.
GetAllZBufferElementModeInfo
Retrieves information about the AllZBufferElementMode setting parameter.
GetAmbientActivationInfo
Retrieves information about the AmbientActivation setting parameter.
GetAntiAliasingModeInfo
Retrieves information about the AntiAliasingMode setting parameter.
GetAntiAliasingOffsetInfo
Retrieves information about the AntiAliasingOffset setting parameter.
GetAuxiliaryDrillViewerInfo
Retrieves information about the AuxiliaryDrillViewer setting parameter.
GetBackFaceCullingMode
Retrieves the BackFaceCullingMode parameter.
GetBackFaceCullingModeInfo
Retrieves information about the BackFaceCullingMode setting parameter.
GetBackgroundRGB
Returns the BackgroundRGB parameter.
GetBackgroundRGBInfo
Retrieves information about the BackgroundRGB setting parameter.
GetBorderEdgesModeInfo
Retrieves information about the BorderEdgesMode setting parameter.
GetBorderEdgesRGB
Returns the BorderEdgesRGB parameter.
GetBorderEdgesRGBInfo
Retrieves information about the BorderEdgesRGB setting parameter.
GetBorderEdgesThicknessInfo
Retrieves information about the BorderEdgesThickness setting parameter.
GetBoundingBoxSelectionModeInfo
Retrieves information about the BoundingBoxSelectionMode setting parameter.
GetColorBackgroundModeInfo
Retrieves information about the ColorBackgroundMode setting parameter.
GetDefaultDiffuseAmbientCoefficientInfo
Retrieves information about the DefaultDiffuseAmbientCoefficient setting parameter.
GetDefaultShininessInfo
Retrieves information about the DefaultShininess setting parameter.
GetDefaultSpecularCoefficientInfo
Retrieves information about the DefaultSpecularCoefficient setting parameter.
GetDisplayCurrentScaleInfo
Retrieves information about the SetStereoModeLock setting parameter.
GetDisplayDrillListInfo
Retrieves information about the DisplayDrillList setting parameter.
GetDisplayImmersiveDrillViewerInfo
Retrieves information about the DisplayImmersiveDrillViewer setting parameter.
GetDynamicCullInfo
Retrieves information about the DynamicCull setting parameter.
GetDynamicLODInfo
Retrieves information about the DynamicLOD setting parameter.
GetFaceHLDrillInfo
Retrieves information about the FaceHLDrill setting parameter.
GetFlyCollisionModeInfo
Retrieves information about the FlyCollisionMode setting parameter.
GetFlyCollisionSphereRadiusInfo
Retrieves information about the FlyCollisionSphereRadius setting parameter.
GetFlyCollisionTypeInfo
Retrieves information about the FlyCollisionType setting parameter.
GetFlySensitivityInfo
Retrieves information about the FlySensitivity setting parameter.
GetFlySpeedInfo
Retrieves information about the FlySpeed setting parameter.
GetFlySpeedModeInfo
Retrieves information about the FlySpeedMode setting parameter.
GetFollowGroundAltitudeInfo
Retrieves information about the FollowGroundAltitude setting parameter.
GetFollowGroundModeInfo
Retrieves information about the FollowGroundMode setting parameter.
GetFullSceneAntiAliasingModeInfo
Retrieves information about the AntiAliasingMode setting parameter.
GetGravityAxisInfo
Retrieves information about the GravityAxis setting parameter.
GetGravityInfo
Retrieves information about the Gravity setting parameter.
GetHaloModeInfo
Retrieves information about the HaloMode setting parameter.
GetHandlesRGB
Returns the HandlesRGB parameter.
GetHandlesRGBInfo
Retrieves information about the HandlesRGB setting parameter.
GetIsoparGenerationModeInfo
Retrieves information about the IsoparGenerationMode setting parameter.
GetKeyboardRotationAngleValueInfo
Retrieves information about the KeyboardRotationAngleValue setting parameter.
GetLightViewerModeInfo
Retrieves information about the LightViewerMode setting parameter.
GetLineicCgrModeInfo
Retrieves information about the LineicCgrMode setting parameter.
GetMaxSelectionMoveInfo
Retrieves information about the MaxSelectionMove setting parameter.
GetMinimumFPSModeInfo
Retrieves information about the MinimumFPSMode setting parameter.
GetMinimumSpaceFPSModeInfo
Retrieves information about the MinimumSpaceFPSMode setting parameter.
GetMouseDoubleClicDelayInfo
Retrieves information about the MouseDoubleClicDelay setting parameter.
GetMouseSpeedValueInfo
Retrieves information about the MouseSpeedValue setting parameter.
GetNbIsoparsInfo
Retrieves information about the NbIsopars setting parameter.
GetNoShowBackgroundRGB
Retrieves the No Show Background Color setting attribute value.
GetNoShowBackgroundRGBInfo
Retrieves the No Show Background Color setting attribute information.
GetNoZBufferSelectionModeInfo
Retrieves information about the NoZBufferSelectionMode setting parameter.
GetNumberOfMinimumFPSInfo
Retrieves information about the NumberOfMinimumFPS setting parameter.
GetNumberOfMinimumSpaceFPSInfo
Retrieves information about the NumberOfMinimumSpaceFPS setting parameter.
GetOcclusionCullingModeInfo
Retrieves information about the OcclusionCullingMode setting parameter.
GetOpaqueFacesInfo
Retrieves information about the SetStereoModeLock setting parameter.
GetOtherSelectionTimeoutActivityInfo
Retrieves information about the OtherSelectionTimeoutActivity setting parameter.
GetOtherSelectionTimeoutInfo
Retrieves information about the OtherSelectionTimeout setting parameter.
GetPickingWindowSizeInfo
Retrieves information about the PickingWindowSize setting parameter.
GetPreSelNavigatorStartedByArrowKeysInfo
Retrieves information about the PreSelNavigatorStartedByArrowKeys setting parameter.
GetPreSelectionModeInfo
Retrieves information about the PreSelectionMode setting parameter.
GetPreselectedElementLinetypeInfo
Retrieves information about the PreselectedElementLinetype setting parameter.
GetPreselectedElementRGB
Returns the PreselectedElementRGB parameter.
GetPreselectedElementRGBInfo
Retrieves information about the PreselectedElementRGB setting parameter.
GetRotationSphereModeInfo
Retrieves information about the RotationSphereMode setting parameter.
GetSelectedEdgeRGB
Returns the SelectedEdgeRGB parameter.
GetSelectedEdgeRGBInfo
Retrieves information about the SelectedEdgeRGB setting parameter.
GetSelectedElementRGB
Returns the SelectedElementRGB parameter.
GetSelectedElementRGBInfo
Retrieves information about the SelectedElementRGB setting parameter.
GetShaderModeInfo
Retrieves information about the ShaderMode setting parameter.
GetStaticCullInfo
Retrieves information about the StaticCull setting parameter.
GetStaticLODInfo
Retrieves information about the StaticLOD setting parameter.
GetStereoModeInfo
Retrieves information about the StereoMode setting parameter.
GetTransparencyModeInfo
Retrieves information about the TransparencyMode setting parameter.
GetTwoSideLightingModeInfo
Retrieves information about the TwoSideLightingMode setting parameter.
GetUnderIntensifiedRGB
Returns the UnderIntensifiedRGB parameter.
GetUnderIntensifiedRGBInfo
Retrieves information about the UnderIntensifiedRGB setting parameter.
GetUpdateNeededRGB
Returns the UpdateNeededRGB parameter.
GetUpdateNeededRGBInfo
Retrieves information about the UpdateNeededRGB setting parameter.
GetViewpointAnimationModeInfo
Retrieves information about the ViewpointAnimationMode setting parameter.
GetViz2DAccuracyModeInfo
Retrieves information about the 2DAccuracyMode setting parameter.
GetViz2DFixedAccuracyInfo
Retrieves information about the 2DFixedAccuracy setting parameter.
GetViz2DProportionnalAccuracyInfo
Retrieves information about the 2DProportionnalAccuracy setting parameter.
GetViz3DAccuracyModeInfo
Retrieves information about the Viz3DAccuracyMode setting parameter.
GetViz3DCurveAccuracyInfo
Retrieves information about the 3DCurveAccuracy setting parameter.
GetViz3DFixedAccuracyInfo
Retrieves information about the 3DFixedAccuracy setting parameter.
GetViz3DProportionnalAccuracyInfo
Retrieves information about the Viz3DProportionnalAccuracy setting parameter.
PutBackFaceCullingMode
Sets the BackFaceCullingMode attribute.
SetAccuratePickingModeLock
Locks or unlocks the AccuratePickingMode setting parameter.
SetAccuratePickingWindowSizeLock
Locks or unlocks the AccuratePickingWindowSize setting parameter.
SetAllZBufferElementModeLock
Locks or unlocks the AllZBufferElementMode setting parameter.
SetAmbientActivationLock
Locks or unlocks the AmbientActivation setting parameter.
SetAntiAliasingModeLock
Locks or unlocks the AntiAliasingMode setting parameter.
SetAntiAliasingOffsetLock
Locks or unlocks the AntiAliasingOffset setting parameter.
SetAuxiliaryDrillViewerLock
Locks or unlocks the AuxiliaryDrillViewer setting parameter.
SetBackFaceCullingModeLock
Locks or unlocks the BackFaceCullingMode setting parameter.
SetBackgroundRGB
Sets the BackgroundRGB parameter.
SetBackgroundRGBLock
Locks or unlocks the BackgroundRGB setting parameter.
SetBorderEdgesModeLock
Locks or unlocks the BorderEdgesMode setting parameter.
SetBorderEdgesRGB
Sets the BorderEdgesRGB parameter.
SetBorderEdgesRGBLock
Locks or unlocks the BorderEdgesRGB setting parameter.
SetBorderEdgesThicknessLock
Locks or unlocks the BorderEdgesThickness setting parameter.
SetBoundingBoxSelectionModeLock
Locks or unlocks the BoundingBoxSelectionMode setting parameter.
SetColorBackgroundModeLock
Locks or unlocks the ColorBackgroundMode setting parameter.
SetDefaultDiffuseAmbientCoefficientLock
Locks or unlocks the DefaultDiffuseAmbientCoefficient setting parameter.
SetDefaultShininessLock
Locks or unlocks the DefaultShininess setting parameter.
SetDefaultSpecularCoefficientLock
Locks or unlocks the DefaultSpecularCoefficient setting parameter.
SetDisplayCurrentScaleLock
Locks or unlocks the SetStereoModeLock setting parameter.
SetDisplayDrillListLock
Locks or unlocks the DisplayDrillList setting parameter.
SetDisplayImmersiveDrillViewerLock
Locks or unlocks the DisplayImmersiveDrillViewer setting parameter.
SetDynamicCullLock
Locks or unlocks the DynamicCull setting parameter.
SetDynamicLODLock
Locks or unlocks the DynamicLOD setting parameter.
SetFaceHLDrillLock
Locks or unlocks the FaceHLDrill setting parameter.
SetFlyCollisionModeLock
Locks or unlocks the FlyCollisionMode setting parameter.
SetFlyCollisionSphereRadiusLock
Locks or unlocks the FlyCollisionSphereRadius setting parameter.
SetFlyCollisionTypeLock
Locks or unlocks the FlyCollisionType setting parameter.
SetFlySensitivityLock
Locks or unlocks the FlySensitivity setting parameter.
SetFlySpeedLock
Locks or unlocks the FlySpeed setting parameter.
SetFlySpeedModeLock
Locks or unlocks the FlySpeedMode setting parameter.
SetFollowGroundAltitudeLock
Locks or unlocks the FollowGroundAltitude setting parameter.
SetFollowGroundModeLock
Locks or unlocks the FollowGroundMode setting parameter.
SetFullSceneAntiAliasingModeLock
Locks or unlocks the AntiAliasingMode setting parameter.
SetGravityAxisLock
Locks or unlocks the GravityAxis setting parameter.
SetGravityLock
Locks or unlocks the Gravity setting parameter.
SetHaloModeLock
Locks or unlocks the HaloMode setting parameter.
SetHandlesRGB
Sets the HandlesRGB parameter.
SetHandlesRGBLock
Locks or unlocks the HandlesRGB setting parameter.
SetIsoparGenerationModeLock
Locks or unlocks the IsoparGenerationMode setting parameter.
SetKeyboardRotationAngleValueLock
Locks or unlocks the KeyboardRotationAngleValue setting parameter.
SetLightViewerModeLock
Locks or unlocks the LightViewerMode setting parameter.
SetLineicCgrModeLock
Locks or unlocks the v setting parameter.
SetMaxSelectionMoveLock
Locks or unlocks the MaxSelectionMove setting parameter.
SetMinimumFPSModeLock
Locks or unlocks the MinimumFPSMode setting parameter.
SetMinimumSpaceFPSModeLock
Locks or unlocks the MinimumSpaceFPSMode setting parameter.
SetMouseDoubleClicDelayLock
Locks or unlocks the MouseDoubleClicDelay setting parameter.
SetMouseSpeedValueLock
Locks or unlocks the MouseSpeedValue setting parameter.
SetNbIsoparsLock
Locks or unlocks the NbIsopars setting parameter.
SetNoShowBackgroundRGB
Sets the No Show Background Color setting attribute value.
SetNoShowBackgroundRGBLock
Locks or unlocks the No Show Background Color setting attribute.
SetNoZBufferSelectionModeLock
Locks or unlocks the NoZBufferSelectionMode setting parameter.
SetNumberOfMinimumFPSLock
Locks or unlocks the NumberOfMinimumFPS setting parameter.
SetNumberOfMinimumSpaceFPSLock
Locks or unlocks the NumberOfMinimumSpaceFPS setting parameter.
SetOcclusionCullingModeLock
Locks or unlocks the OcclusionCullingMode setting parameter.
SetOpaqueFacesLock
Locks or unlocks the SetStereoModeLock setting parameter.
SetOtherSelectionTimeoutActivityLock
Locks or unlocks the OtherSelectionTimeoutActivity setting parameter.
SetOtherSelectionTimeoutLock
Locks or unlocks the OtherSelectionTimeout setting parameter.
SetPickingWindowSizeLock
Locks or unlocks the PickingWindowSize setting parameter.
SetPreSelNavigatorStartedByArrowKeysLock
Locks or unlocks the PreSelNavigatorStartedByArrowKeys setting parameter.
SetPreSelectionModeLock
Locks or unlocks the PreSelectionMode setting parameter.
SetPreselectedElementLinetypeLock
Locks or unlocks the PreselectedElementLinetype setting parameter.
SetPreselectedElementRGB
Sets the PreselectedElementRGB parameter.
SetPreselectedElementRGBLock
Locks or unlocks the PreselectedElementRGB setting parameter.
SetRotationSphereModeLock
Locks or unlocks the RotationSphereMode setting parameter.
SetSelectedEdgeRGB
Sets the SelectedEdgeRGB parameter.
SetSelectedEdgeRGBLock
Locks or unlocks the SelectedEdgeRGB setting parameter.
SetSelectedElementRGB
Sets the SelectedElementRGB parameter.
SetSelectedElementRGBLock
Locks or unlocks the SelectedElementRGB setting parameter.
SetShaderModeLock
Locks or unlocks the ShaderMode setting parameter.
SetStaticCullLock
Locks or unlocks the StaticCull setting parameter.
SetStaticLODLock
Locks or unlocks the StaticLOD setting parameter.
SetStereoModeLock
Locks or unlocks the StereoMode setting parameter.
SetTransparencyModeLock
Locks or unlocks the TransparencyMode setting parameter.
SetTwoSideLightingModeLock
Locks or unlocks the TwoSideLightingMode setting parameter.
SetUnderIntensifiedRGB
Sets the UnderIntensifiedRGB parameter.
SetUnderIntensifiedRGBLock
Locks or unlocks the UnderIntensifiedRGB setting parameter.
SetUpdateNeededRGB
Sets the UpdateNeededRGB parameter.
SetUpdateNeededRGBLock
Locks or unlocks the UpdateNeededRGB setting parameter.
SetViewpointAnimationModeLock
Locks or unlocks the ViewpointAnimationMode setting parameter.
SetViz2DAccuracyModeLock
Locks or unlocks the 2DAccuracyMode setting parameter.
SetViz2DFixedAccuracyLock
Locks or unlocks the 2DFixedAccuracy setting parameter.
SetViz2DProportionnalAccuracyLock
Locks or unlocks the 2DProportionnalAccuracy setting parameter.
SetViz3DAccuracyModeLock
Locks or unlocks the Viz3DAccuracyMode setting parameter.
SetViz3DCurveAccuracyLock
Locks or unlocks the 3DCurveAccuracy setting parameter.
SetViz3DFixedAccuracyLock
Locks or unlocks the 3DFixedAccuracy setting parameter.
SetViz3DProportionnalAccuracyLock
Locks or unlocks the Viz3DProportionnalAccuracy setting parameter.
Properties
Property AccuratePickingMode() As
Returns the AccuratePickingMode parameter.
Property AccuratePickingWindowSize() As
Returns the AccuratePickingWindowSize parameter.
Property AllZBufferElementMode() As
Returns the AllZBufferElementMode parameter.
Property AmbientActivation() As
Returns the AmbientActivation parameter.
Property AntiAliasingMode() As
Returns the AntiAliasingMode parameter.
Property AntiAliasingOffset() As
Returns the AntiAliasingOffset parameter.
Property AuxiliaryDrillViewer() As
Returns the AuxiliaryDrillViewer parameter.
Property BackFaceCullingMode() As
Deprecated:
V5R16.
Returns the BackFaceCullingMode parameter.
Property BorderEdgesMode() As
Returns the BorderEdgesMode parameter.
Property BorderEdgesThickness() As
Returns the BorderEdgesThickness parameter.
Property BoundingBoxSelectionMode() As
Returns the BoundingBoxSelectionMode parameter.
Property ColorBackgroundMode() As
Returns the ColorBackgroundMode parameter.
Property DefaultDiffuseAmbientCoefficient() As
Returns the AmbientActivation parameter.
Property DefaultShininess() As
Returns the AmbientActivation parameter.
Property DefaultSpecularCoefficient() As
Returns the AmbientActivation parameter.
Property DisplayCurrentScale() As
Returns the SetStereoModeLock parameter.
Property DisplayDrillList() As
Returns the DisplayDrillList parameter.
Property DisplayImmersiveDrillViewer() As
Returns the DisplayImmersiveDrillViewer parameter.
Property DynamicCull() As
Returns the DynamicCull parameter.
Property DynamicLOD() As
Returns the DynamicLOD parameter.
Property FaceHLDrill() As
Returns the FaceHLDrill parameter.
Property FlyCollisionMode() As
Returns the FlyCollisionMode parameter.
Property FlyCollisionSphereRadius() As
Returns the FlyCollisionSphereRadius parameter.
Property FlyCollisionType() As
Returns the FlyCollisionType parameter.
Property FlySensitivity() As
Returns the FlySensitivity parameter.
Property FlySpeed() As
Returns the FlySpeed parameter.
Property FlySpeedMode() As
Returns the FlySpeedMode parameter.
Property FollowGroundAltitude() As
Returns the FollowGroundAltitude parameter.
Property FollowGroundMode() As
Returns the FollowGroundMode parameter.
Property FullSceneAntiAliasingMode() As
Returns the AntiAliasingMode parameter.
Property Gravity() As
Returns the Gravity parameter.
Property GravityAxis() As
Returns the GravityAxis parameter.
Property HaloMode() As
Returns the HaloMode parameter.
Property IsoparGenerationMode() As
Returns the IsoparGenerationMode parameter.
Property KeyboardRotationAngleValue() As
Retrieves the angle value for rotations operated through key combinations.
Property LightViewerMode() As
Returns the LightViewerMode parameter.
Property LineicCgrMode() As
Returns the LineicCgrMode parameter.
Property MaxSelectionMove() As
Returns the MaxSelectionMove parameter.
Property MinimumFPSMode() As
Returns the MinimumFPSMode parameter.
Property MinimumSpaceFPSMode() As
Returns the MinimumSpaceFPSMode parameter.
Property MouseDoubleClicDelay() As
Returns the MouseDoubleClicDelay parameter.
Property MouseSpeedValue() As
Returns the MouseSpeedValue parameter.
Property NbIsopars() As
Returns the NbIsopars parameter.
Property NoZBufferSelectionMode() As
Returns the NoZBufferSelectionMode parameter.
Property NumberOfMinimumFPS() As
Returns the NumberOfMinimumFPS parameter.
Property NumberOfMinimumSpaceFPS() As
Returns the NumberOfMinimumSpaceFPS parameter.
Property OcclusionCullingMode() As
Returns the OcclusionCullingMode parameter.
Property OpaqueFaces() As
Returns the SetStereoModeLock parameter.
Property OtherSelectionTimeout() As
Returns the OtherSelectionTimeout parameter.
Property OtherSelectionTimeoutActivity() As
Returns the OtherSelectionTimeoutActivity parameter.
Property PickingWindowSize() As
Returns the PickingWindowSize parameter.
Property PreSelNavigatorStartedByArrowKeys() As
Returns the PreSelNavigatorStartedByArrowKeys parameter.
Property PreSelectionMode() As
Returns the PreSelectionMode parameter.
Property PreselectedElementLinetype() As
Returns the PreselectedElementLinetype parameter.
Property RotationSphereMode() As
Returns the RotationSphereMode parameter.
Property ShaderMode() As
Returns the ShaderMode parameter.
Property StaticCull() As
Returns the StaticCull parameter.
Property StaticLOD() As
Returns the StaticLOD parameter.
Property StereoMode() As
Returns the StereoMode parameter.
Property TransparencyMode() As
Returns the TransparencyMode parameter.
Property TwoSideLightingMode() As
Returns the TwoSideLightingMode parameter.
Property ViewpointAnimationMode() As
Returns the ViewpointAnimationMode parameter.
Property Viz2DAccuracyMode() As
Returns the 2DAccuracyMode parameter.
Property Viz2DFixedAccuracy() As
Returns the 2DFixedAccuracy parameter.
Property Viz2DProportionnalAccuracy() As
Returns the 2DProportionnalAccuracy parameter.
Property Viz3DAccuracyMode() As
Returns the Viz3DAccuracyMode parameter.
Property Viz3DCurveAccuracy() As
Returns the 3DCurveAccuracy parameter.
Property Viz3DFixedAccuracy() As
Returns the 3DFixedAccuracy parameter.
Property Viz3DProportionnalAccuracy() As
Returns the Viz3DProportionnalAccuracy parameter.
Methods
Func GetAccuratePickingModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the AccuratePickingMode setting parameter.
Refer to
for a detailed description.
Func GetAccuratePickingWindowSizeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the AccuratePickingWindowSize setting parameter.
Refer to
for a detailed description.
Func GetAllZBufferElementModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the AllZBufferElementMode setting parameter.
Refer to
for a detailed description.
Func GetAmbientActivationInfo( ioAdminLevel, ioLocked) As
Retrieves information about the AmbientActivation setting parameter.
Refer to
for a detailed description.
Func GetAntiAliasingModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the AntiAliasingMode setting parameter.
Refer to
for a detailed description.
Func GetAntiAliasingOffsetInfo( ioAdminLevel, ioLocked) As
Retrieves information about the AntiAliasingOffset setting parameter.
Refer to
for a detailed description.
Func GetAuxiliaryDrillViewerInfo( ioAdminLevel, ioLocked) As
Retrieves information about the AuxiliaryDrillViewer setting parameter.
Refer to
for a detailed description.
Func GetBackFaceCullingMode() As
Retrieves the BackFaceCullingMode parameter.
Parameters:
oBackFaceCullingMode
Value of the back face culling mode setting option. The retrieved value can be one of the four possible values
defined by the
enumeration.
Returns:
An HRESULT.
Legal values:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
Func GetBackFaceCullingModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the BackFaceCullingMode setting parameter.
Refer to
for a detailed description.
Sub GetBackgroundRGB( ioR, ioG, ioB)
Returns the BackgroundRGB parameter.
Func GetBackgroundRGBInfo( ioAdminLevel, ioLocked) As
Retrieves information about the BackgroundRGB setting parameter.
Refer to
for a detailed description.
Func GetBorderEdgesModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the BorderEdgesMode setting parameter.
Refer to
for a detailed description.
Sub GetBorderEdgesRGB( ioR, ioG, ioB)
Returns the BorderEdgesRGB parameter.
Func GetBorderEdgesRGBInfo( ioAdminLevel, ioLocked) As
Retrieves information about the BorderEdgesRGB setting parameter.
Refer to
for a detailed description.
Func GetBorderEdgesThicknessInfo( ioAdminLevel, ioLocked) As
Retrieves information about the BorderEdgesThickness setting parameter.
Refer to
for a detailed description.
Func GetBoundingBoxSelectionModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the BoundingBoxSelectionMode setting parameter.
Refer to
for a detailed description.
Func GetColorBackgroundModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ColorBackgroundMode setting parameter.
Refer to
for a detailed description.
Func GetDefaultDiffuseAmbientCoefficientInfo( ioAdminLevel, ioLocked) As
Retrieves information about the DefaultDiffuseAmbientCoefficient setting parameter.
Refer to
for a detailed description.
Func GetDefaultShininessInfo( ioAdminLevel, ioLocked) As
Retrieves information about the DefaultShininess setting parameter.
Refer to
for a detailed description.
Func GetDefaultSpecularCoefficientInfo( ioAdminLevel, ioLocked) As
Retrieves information about the DefaultSpecularCoefficient setting parameter.
Refer to
for a detailed description.
Func GetDisplayCurrentScaleInfo( ioAdminLevel, ioLocked) As
Retrieves information about the SetStereoModeLock setting parameter.
Refer to
for a detailed description.
Func GetDisplayDrillListInfo( ioAdminLevel, ioLocked) As
Retrieves information about the DisplayDrillList setting parameter.
Refer to
for a detailed description.
Func GetDisplayImmersiveDrillViewerInfo( ioAdminLevel, ioLocked) As
Retrieves information about the DisplayImmersiveDrillViewer setting parameter.
Refer to
for a detailed description.
Func GetDynamicCullInfo( ioAdminLevel, ioLocked) As
Retrieves information about the DynamicCull setting parameter.
Refer to
for a detailed description.
Func GetDynamicLODInfo( ioAdminLevel, ioLocked) As
Retrieves information about the DynamicLOD setting parameter.
Refer to
for a detailed description.
Func GetFaceHLDrillInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FaceHLDrill setting parameter.
Refer to
for a detailed description.
Func GetFlyCollisionModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FlyCollisionMode setting parameter.
Refer to
for a detailed description.
Func GetFlyCollisionSphereRadiusInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FlyCollisionSphereRadius setting parameter.
Refer to
for a detailed description.
Func GetFlyCollisionTypeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FlyCollisionType setting parameter.
Refer to
for a detailed description.
Func GetFlySensitivityInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FlySensitivity setting parameter.
Refer to
for a detailed description.
Func GetFlySpeedInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FlySpeed setting parameter.
Refer to
for a detailed description.
Func GetFlySpeedModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FlySpeedMode setting parameter.
Refer to
for a detailed description.
Func GetFollowGroundAltitudeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FollowGroundAltitude setting parameter.
Refer to
for a detailed description.
Func GetFollowGroundModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the FollowGroundMode setting parameter.
Refer to
for a detailed description.
Func GetFullSceneAntiAliasingModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the AntiAliasingMode setting parameter.
Refer to
for a detailed description.
Func GetGravityAxisInfo( ioAdminLevel, ioLocked) As
Retrieves information about the GravityAxis setting parameter.
Refer to
for a detailed description.
Func GetGravityInfo( ioAdminLevel, ioLocked) As
Retrieves information about the Gravity setting parameter.
Refer to
for a detailed description.
Func GetHaloModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the HaloMode setting parameter.
Refer to
for a detailed description.
Sub GetHandlesRGB( ioR, ioG, ioB)
Returns the HandlesRGB parameter.
Func GetHandlesRGBInfo( ioAdminLevel, ioLocked) As
Retrieves information about the HandlesRGB setting parameter.
Refer to
for a detailed description.
Func GetIsoparGenerationModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the IsoparGenerationMode setting parameter.
Refer to
for a detailed description.
Func GetKeyboardRotationAngleValueInfo( ioAdminLevel, ioLocked) As
Retrieves information about the KeyboardRotationAngleValue setting parameter.
Refer to
for a detailed description.
Func GetLightViewerModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the LightViewerMode setting parameter.
Refer to
for a detailed description.
Func GetLineicCgrModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the LineicCgrMode setting parameter.
Refer to
for a detailed description.
Func GetMaxSelectionMoveInfo( ioAdminLevel, ioLocked) As
Retrieves information about the MaxSelectionMove setting parameter.
Refer to
for a detailed description.
Func GetMinimumFPSModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the MinimumFPSMode setting parameter.
Refer to
for a detailed description.
Func GetMinimumSpaceFPSModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the MinimumSpaceFPSMode setting parameter.
Refer to
for a detailed description.
Func GetMouseDoubleClicDelayInfo( ioAdminLevel, ioLocked) As
Retrieves information about the MouseDoubleClicDelay setting parameter.
Refer to
for a detailed description.
Func GetMouseSpeedValueInfo( ioAdminLevel, ioLocked) As
Retrieves information about the MouseSpeedValue setting parameter.
Refer to
for a detailed description.
Func GetNbIsoparsInfo( ioAdminLevel, ioLocked) As
Retrieves information about the NbIsopars setting parameter.
Refer to
for a detailed description.
Sub GetNoShowBackgroundRGB( ioR, ioG, ioB)
Retrieves the No Show Background Color setting attribute value.
Role: The No Show Background Color setting attribute manages the backgraound color of no show space
Parameters:
ioR,
ioG, ioB [inout]   The Red, Green, Blue components of the No Show Background Color setting attribute value
Returns:
S_OK if the No Show Background Color setting attribute value
is successfully retrieved, and E_FAIL otherwise
Func GetNoShowBackgroundRGBInfo( ioAdminLevel, ioLocked) As
Retrieves the No Show Background Color setting attribute information.
Parameters:
ioAdminLevel,
ioLocked [inout] and oModified [out]   The No Show Background Color setting attribute information
Returns:
S_OK if the No Show Background Color setting attribute
information is successfully retrieved, and E_FAIL otherwise
Refer to
for a detailed description.
Func GetNoZBufferSelectionModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the NoZBufferSelectionMode setting parameter.
Refer to
for a detailed description.
Func GetNumberOfMinimumFPSInfo( ioAdminLevel, ioLocked) As
Retrieves information about the NumberOfMinimumFPS setting parameter.
Refer to
for a detailed description.
Func GetNumberOfMinimumSpaceFPSInfo( ioAdminLevel, ioLocked) As
Retrieves information about the NumberOfMinimumSpaceFPS setting parameter.
Refer to
for a detailed description.
Func GetOcclusionCullingModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the OcclusionCullingMode setting parameter.
Refer to
for a detailed description.
Func GetOpaqueFacesInfo( ioAdminLevel, ioLocked) As
Retrieves information about the SetStereoModeLock setting parameter.
Refer to
for a detailed description.
Func GetOtherSelectionTimeoutActivityInfo( ioAdminLevel, ioLocked) As
Retrieves information about the OtherSelectionTimeoutActivity setting parameter.
Refer to
for a detailed description.
Func GetOtherSelectionTimeoutInfo( ioAdminLevel, ioLocked) As
Retrieves information about the OtherSelectionTimeout setting parameter.
Refer to
for a detailed description.
Func GetPickingWindowSizeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the PickingWindowSize setting parameter.
Refer to
for a detailed description.
Func GetPreSelNavigatorStartedByArrowKeysInfo( ioAdminLevel, ioLocked) As
Retrieves information about the PreSelNavigatorStartedByArrowKeys setting parameter.
Refer to
for a detailed description.
Func GetPreSelectionModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the PreSelectionMode setting parameter.
Refer to
for a detailed description.
Func GetPreselectedElementLinetypeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the PreselectedElementLinetype setting parameter.
Refer to
for a detailed description.
Sub GetPreselectedElementRGB( ioR, ioG, ioB)
Returns the PreselectedElementRGB parameter.
Func GetPreselectedElementRGBInfo( ioAdminLevel, ioLocked) As
Retrieves information about the PreselectedElementRGB setting parameter.
Refer to
for a detailed description.
Func GetRotationSphereModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the RotationSphereMode setting parameter.
Refer to
for a detailed description.
Sub GetSelectedEdgeRGB( ioR, ioG, ioB)
Returns the SelectedEdgeRGB parameter.
Func GetSelectedEdgeRGBInfo( ioAdminLevel, ioLocked) As
Retrieves information about the SelectedEdgeRGB setting parameter.
Refer to
for a detailed description.
Sub GetSelectedElementRGB( ioR, ioG, ioB)
Returns the SelectedElementRGB parameter.
Func GetSelectedElementRGBInfo( ioAdminLevel, ioLocked) As
Retrieves information about the SelectedElementRGB setting parameter.
Refer to
for a detailed description.
Func GetShaderModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ShaderMode setting parameter.
Refer to
for a detailed description.
Func GetStaticCullInfo( ioAdminLevel, ioLocked) As
Retrieves information about the StaticCull setting parameter.
Refer to
for a detailed description.
Func GetStaticLODInfo( ioAdminLevel, ioLocked) As
Retrieves information about the StaticLOD setting parameter.
Refer to
for a detailed description.
Func GetStereoModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the StereoMode setting parameter.
Refer to
for a detailed description.
Func GetTransparencyModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the TransparencyMode setting parameter.
Refer to
for a detailed description.
Func GetTwoSideLightingModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the TwoSideLightingMode setting parameter.
Refer to
for a detailed description.
Sub GetUnderIntensifiedRGB( ioR, ioG, ioB)
Returns the UnderIntensifiedRGB parameter.
Func GetUnderIntensifiedRGBInfo( ioAdminLevel, ioLocked) As
Retrieves information about the UnderIntensifiedRGB setting parameter.
Refer to
for a detailed description.
Sub GetUpdateNeededRGB( ioR, ioG, ioB)
Returns the UpdateNeededRGB parameter.
Func GetUpdateNeededRGBInfo( ioAdminLevel, ioLocked) As
Retrieves information about the UpdateNeededRGB setting parameter.
Refer to
for a detailed description.
Func GetViewpointAnimationModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ViewpointAnimationMode setting parameter.
Refer to
for a detailed description.
Func GetViz2DAccuracyModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the 2DAccuracyMode setting parameter.
Refer to
for a detailed description.
Func GetViz2DFixedAccuracyInfo( ioAdminLevel, ioLocked) As
Retrieves information about the 2DFixedAccuracy setting parameter.
Refer to
for a detailed description.
Func GetViz2DProportionnalAccuracyInfo( ioAdminLevel, ioLocked) As
Retrieves information about the 2DProportionnalAccuracy setting parameter.
Refer to
for a detailed description.
Func GetViz3DAccuracyModeInfo( ioAdminLevel, ioLocked) As
Retrieves information about the Viz3DAccuracyMode setting parameter.
Refer to
for a detailed description.
Func GetViz3DCurveAccuracyInfo( ioAdminLevel, ioLocked) As
Retrieves information about the 3DCurveAccuracy setting parameter.
Refer to
for a detailed description.
Func GetViz3DFixedAccuracyInfo( ioAdminLevel, ioLocked) As
Retrieves information about the 3DFixedAccuracy setting parameter.
Refer to
for a detailed description.
Func GetViz3DProportionnalAccuracyInfo( ioAdminLevel, ioLocked) As
Retrieves information about the Viz3DProportionnalAccuracy setting parameter.
Refer to
for a detailed description.
Sub PutBackFaceCullingMode( iBackFaceCullingMode)
Sets the BackFaceCullingMode attribute.
Parameters:
iBackFaceCullingMode
Value of the back face culling mode setting option. The value to set can be one of the four possible values
defined by the
enumeration.
Returns:
An HRESULT.
Legal values:
S_OK
if the operation succeeded.
E_FAIL
if the operation failed.
Sub SetAccuratePickingModeLock( iLocked)
Locks or unlocks the AccuratePickingMode setting parameter.
Refer to
for a detailed description.
Sub SetAccuratePickingWindowSizeLock( iLocked)
Locks or unlocks the AccuratePickingWindowSize setting parameter.
Refer to
for a detailed description.
Sub SetAllZBufferElementModeLock( iLocked)
Locks or unlocks the AllZBufferElementMode setting parameter.
Refer to
for a detailed description.
Sub SetAmbientActivationLock( iLocked)
Locks or unlocks the AmbientActivation setting parameter.
Refer to
for a detailed description.
Sub SetAntiAliasingModeLock( iLocked)
Locks or unlocks the AntiAliasingMode setting parameter.
Refer to
for a detailed description.
Sub SetAntiAliasingOffsetLock( iLocked)
Locks or unlocks the AntiAliasingOffset setting parameter.
Refer to
for a detailed description.
Sub SetAuxiliaryDrillViewerLock( iLocked)
Locks or unlocks the AuxiliaryDrillViewer setting parameter.
Refer to
for a detailed description.
Sub SetBackFaceCullingModeLock( iLocked)
Locks or unlocks the BackFaceCullingMode setting parameter.
Refer to
for a detailed description.
Sub SetBackgroundRGB( iR, iG, iB)
Sets the BackgroundRGB parameter.
Sub SetBackgroundRGBLock( iLocked)
Locks or unlocks the BackgroundRGB setting parameter.
Refer to
for a detailed description.
Sub SetBorderEdgesModeLock( iLocked)
Locks or unlocks the BorderEdgesMode setting parameter.
Refer to
for a detailed description.
Sub SetBorderEdgesRGB( iR, iG, iB)
Sets the BorderEdgesRGB parameter.
Sub SetBorderEdgesRGBLock( iLocked)
Locks or unlocks the BorderEdgesRGB setting parameter.
Refer to
for a detailed description.
Sub SetBorderEdgesThicknessLock( iLocked)
Locks or unlocks the BorderEdgesThickness setting parameter.
Refer to
for a detailed description.
Sub SetBoundingBoxSelectionModeLock( iLocked)
Locks or unlocks the BoundingBoxSelectionMode setting parameter.
Refer to
for a detailed description.
Sub SetColorBackgroundModeLock( iLocked)
Locks or unlocks the ColorBackgroundMode setting parameter.
Refer to
for a detailed description.
Sub SetDefaultDiffuseAmbientCoefficientLock( iLocked)
Locks or unlocks the DefaultDiffuseAmbientCoefficient setting parameter.
Refer to
for a detailed description.
Sub SetDefaultShininessLock( iLocked)
Locks or unlocks the DefaultShininess setting parameter.
Refer to
for a detailed description.
Sub SetDefaultSpecularCoefficientLock( iLocked)
Locks or unlocks the DefaultSpecularCoefficient setting parameter.
Refer to
for a detailed description.
Sub SetDisplayCurrentScaleLock( iLocked)
Locks or unlocks the SetStereoModeLock setting parameter.
Refer to
for a detailed description.
Sub SetDisplayDrillListLock( iLocked)
Locks or unlocks the DisplayDrillList setting parameter.
Refer to
for a detailed description.
Sub SetDisplayImmersiveDrillViewerLock( iLocked)
Locks or unlocks the DisplayImmersiveDrillViewer setting parameter.
Refer to
for a detailed description.
Sub SetDynamicCullLock( iLocked)
Locks or unlocks the DynamicCull setting parameter.
Refer to
for a detailed description.
Sub SetDynamicLODLock( iLocked)
Locks or unlocks the DynamicLOD setting parameter.
Refer to
for a detailed description.
Sub SetFaceHLDrillLock( iLocked)
Locks or unlocks the FaceHLDrill setting parameter.
Refer to
for a detailed description.
Sub SetFlyCollisionModeLock( iLocked)
Locks or unlocks the FlyCollisionMode setting parameter.
Refer to
for a detailed description.
Sub SetFlyCollisionSphereRadiusLock( iLocked)
Locks or unlocks the FlyCollisionSphereRadius setting parameter.
Refer to
for a detailed description.
Sub SetFlyCollisionTypeLock( iLocked)
Locks or unlocks the FlyCollisionType setting parameter.
Refer to
for a detailed description.
Sub SetFlySensitivityLock( iLocked)
Locks or unlocks the FlySensitivity setting parameter.
Refer to
for a detailed description.
Sub SetFlySpeedLock( iLocked)
Locks or unlocks the FlySpeed setting parameter.
Refer to
for a detailed description.
Sub SetFlySpeedModeLock( iLocked)
Locks or unlocks the FlySpeedMode setting parameter.
Refer to
for a detailed description.
Sub SetFollowGroundAltitudeLock( iLocked)
Locks or unlocks the FollowGroundAltitude setting parameter.
Refer to
for a detailed description.
Sub SetFollowGroundModeLock( iLocked)
Locks or unlocks the FollowGroundMode setting parameter.
Refer to
for a detailed description.
Sub SetFullSceneAntiAliasingModeLock( iLocked)
Locks or unlocks the AntiAliasingMode setting parameter.
Refer to
for a detailed description.
Sub SetGravityAxisLock( iLocked)
Locks or unlocks the GravityAxis setting parameter.
Refer to
for a detailed description.
Sub SetGravityLock( iLocked)
Locks or unlocks the Gravity setting parameter.
Refer to
for a detailed description.
Sub SetHaloModeLock( iLocked)
Locks or unlocks the HaloMode setting parameter.
Refer to
for a detailed description.
Sub SetHandlesRGB( iR, iG, iB)
Sets the HandlesRGB parameter.
Sub SetHandlesRGBLock( iLocked)
Locks or unlocks the HandlesRGB setting parameter.
Refer to
for a detailed description.
Sub SetIsoparGenerationModeLock( iLocked)
Locks or unlocks the IsoparGenerationMode setting parameter.
Refer to
for a detailed description.
Sub SetKeyboardRotationAngleValueLock( iLocked)
Locks or unlocks the KeyboardRotationAngleValue setting parameter.
Refer to
for a detailed description.
Sub SetLightViewerModeLock( iLocked)
Locks or unlocks the LightViewerMode setting parameter.
Refer to
for a detailed description.
Sub SetLineicCgrModeLock( iLocked)
Locks or unlocks the v setting parameter.
Refer to
for a detailed description.
Sub SetMaxSelectionMoveLock( iLocked)
Locks or unlocks the MaxSelectionMove setting parameter.
Refer to
for a detailed description.
Sub SetMinimumFPSModeLock( iLocked)
Locks or unlocks the MinimumFPSMode setting parameter.
Refer to
for a detailed description.
Sub SetMinimumSpaceFPSModeLock( iLocked)
Locks or unlocks the MinimumSpaceFPSMode setting parameter.
Refer to
for a detailed description.
Sub SetMouseDoubleClicDelayLock( iLocked)
Locks or unlocks the MouseDoubleClicDelay setting parameter.
Refer to
for a detailed description.
Sub SetMouseSpeedValueLock( iLocked)
Locks or unlocks the MouseSpeedValue setting parameter.
Refer to
for a detailed description.
Sub SetNbIsoparsLock( iLocked)
Locks or unlocks the NbIsopars setting parameter.
Refer to
for a detailed description.
Sub SetNoShowBackgroundRGB( iR, iG, iB)
Sets the No Show Background Color setting attribute value.
Role: The No Show Background Color setting attribute manages the backgraound color of no show space
Parameters:
iR,
iG, iB [in]   The Red, Green, Blue components of the No Show Background Color setting attribute value
Legal values: between 0 and 255
Returns:
S_OK if the No Show Background Color setting attribute value
is successfully set, and E_FAIL otherwise
Sub SetNoShowBackgroundRGBLock( iLocked)
Locks or unlocks the No Show Background Color setting attribute.
Role: Locks or unlocks the No Show Background Color setting attribute
if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
Parameters:
iLocked
[in]   A flag to indicate whether the No Show Background Color setting attribute should be locked.
Legal values:
TRUE to lock
FALSE to unlock
Returns:
S_OK if the No Show Background Color setting attribute
is successfully locked or unlocked, and E_FAIL otherwise
Refer to
for a detailed description.
Sub SetNoZBufferSelectionModeLock( iLocked)
Locks or unlocks the NoZBufferSelectionMode setting parameter.
Refer to
for a detailed description.
Sub SetNumberOfMinimumFPSLock( iLocked)
Locks or unlocks the NumberOfMinimumFPS setting parameter.
Refer to
for a detailed description.
Sub SetNumberOfMinimumSpaceFPSLock( iLocked)
Locks or unlocks the NumberOfMinimumSpaceFPS setting parameter.
Refer to
for a detailed description.
Sub SetOcclusionCullingModeLock( iLocked)
Locks or unlocks the OcclusionCullingMode setting parameter.
Refer to
for a detailed description.
Sub SetOpaqueFacesLock( iLocked)
Locks or unlocks the SetStereoModeLock setting parameter.
Refer to
for a detailed description.
Sub SetOtherSelectionTimeoutActivityLock( iLocked)
Locks or unlocks the OtherSelectionTimeoutActivity setting parameter.
Refer to
for a detailed description.
Sub SetOtherSelectionTimeoutLock( iLocked)
Locks or unlocks the OtherSelectionTimeout setting parameter.
Refer to
for a detailed description.
Sub SetPickingWindowSizeLock( iLocked)
Locks or unlocks the PickingWindowSize setting parameter.
Refer to
for a detailed description.
Sub SetPreSelNavigatorStartedByArrowKeysLock( iLocked)
Locks or unlocks the PreSelNavigatorStartedByArrowKeys setting parameter.
Refer to
for a detailed description.
Sub SetPreSelectionModeLock( iLocked)
Locks or unlocks the PreSelectionMode setting parameter.
Refer to
for a detailed description.
Sub SetPreselectedElementLinetypeLock( iLocked)
Locks or unlocks the PreselectedElementLinetype setting parameter.
Refer to
for a detailed description.
Sub SetPreselectedElementRGB( iR, iG, iB)
Sets the PreselectedElementRGB parameter.
Sub SetPreselectedElementRGBLock( iLocked)
Locks or unlocks the PreselectedElementRGB setting parameter.
Refer to
for a detailed description.
Sub SetRotationSphereModeLock( iLocked)
Locks or unlocks the RotationSphereMode setting parameter.
Refer to
for a detailed description.
Sub SetSelectedEdgeRGB( iR, iG, iB)
Sets the SelectedEdgeRGB parameter.
Sub SetSelectedEdgeRGBLock( iLocked)
Locks or unlocks the SelectedEdgeRGB setting parameter.
Refer to
for a detailed description.
Sub SetSelectedElementRGB( iR, iG, iB)
Sets the SelectedElementRGB parameter.
Sub SetSelectedElementRGBLock( iLocked)
Locks or unlocks the SelectedElementRGB setting parameter.
Refer to
for a detailed description.
Sub SetShaderModeLock( iLocked)
Locks or unlocks the ShaderMode setting parameter.
Refer to
for a detailed description.
Sub SetStaticCullLock( iLocked)
Locks or unlocks the StaticCull setting parameter.
Refer to
for a detailed description.
Sub SetStaticLODLock( iLocked)
Locks or unlocks the StaticLOD setting parameter.
Refer to
for a detailed description.
Sub SetStereoModeLock( iLocked)
Locks or unlocks the StereoMode setting parameter.
Refer to
for a detailed description.
Sub SetTransparencyModeLock( iLocked)
Locks or unlocks the TransparencyMode setting parameter.
Refer to
for a detailed description.
Sub SetTwoSideLightingModeLock( iLocked)
Locks or unlocks the TwoSideLightingMode setting parameter.
Refer to
for a detailed description.
Sub SetUnderIntensifiedRGB( iR, iG, iB)
Sets the UnderIntensifiedRGB parameter.
Sub SetUnderIntensifiedRGBLock( iLocked)
Locks or unlocks the UnderIntensifiedRGB setting parameter.
Refer to
for a detailed description.
Sub SetUpdateNeededRGB( iR, iG, iB)
Sets the UpdateNeededRGB parameter.
Sub SetUpdateNeededRGBLock( iLocked)
Locks or unlocks the UpdateNeededRGB setting parameter.
Refer to
for a detailed description.
Sub SetViewpointAnimationModeLock( iLocked)
Locks or unlocks the ViewpointAnimationMode setting parameter.
Refer to
for a detailed description.
Sub SetViz2DAccuracyModeLock( iLocked)
Locks or unlocks the 2DAccuracyMode setting parameter.
Refer to
for a detailed description.
Sub SetViz2DFixedAccuracyLock( iLocked)
Locks or unlocks the 2DFixedAccuracy setting parameter.
Refer to
for a detailed description.
Sub SetViz2DProportionnalAccuracyLock( iLocked)
Locks or unlocks the 2DProportionnalAccuracy setting parameter.
Refer to
for a detailed description.
Sub SetViz3DAccuracyModeLock( iLocked)
Locks or unlocks the Viz3DAccuracyMode setting parameter.
Refer to
for a detailed description.
Sub SetViz3DCurveAccuracyLock( iLocked)
Locks or unlocks the 3DCurveAccuracy setting parameter.
Refer to
for a detailed description.
Sub SetViz3DFixedAccuracyLock( iLocked)
Locks or unlocks the 3DFixedAccuracy setting parameter.
Refer to
for a detailed description.
Sub SetViz3DProportionnalAccuracyLock( iLocked)
Locks or unlocks the Viz3DProportionnalAccuracy setting parameter.
Refer to
for a detailed description.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_VrmlSettingAtt_21297 ===
InfInterfaces VrmlSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
VrmlSettingAtt (Object)
The interface to access a CATIAVrmlSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option\General\Compatibility.... the settings values
of the VRML sheet.
Property Index
ExportEdges
Returns or sets the ExportEdges parameter (exported Vrml files will or will not contains edge informations).
ExportNormals
Returns or sets the ExportNormals parameter (exported Vrml files will or will not contains normal informations).
ExportTexture
Returns or sets the ExportTexture parameter (exported Vrml files will or will not contains texture informations).
ExportTextureFile
Returns or sets the ExportTextureFile parameter (Textures will be exported in the vrml file containing the geometry
or in external files).
ExportTextureFormat
Returns or sets the ExportTextureFormat parameter.
ExportVersion
Returns or sets the ExportVersion parameter (version of exported Vrml files).
ImportCreaseAngle
Returns or sets the ImportCreaseAngle parameter.
ImportUnit
Returns or sets the ImportUnit parameter (unit of imported Vrml files).
Method Index
GetExportBackgroundColor
Returns the ExportBackgroundColor parameter (Background color of exported Vrml files).
GetExportBackgroundColorInfo
Retrieves information about the ExportBackgroundColor setting parameter.
GetExportEdgesInfo
Retrieves information about the ExportEdges setting parameter.
GetExportNormalsInfo
Retrieves information about the ExportNormals setting parameter.
GetExportTextureFileInfo
Retrieves information about the ExportTextureFile setting parameter.
GetExportTextureFormatInfo
Retrieves information about the ExportTextureFormat setting parameter.
GetExportTextureInfo
Retrieves information about the ExportTexture setting parameter.
GetExportVersionInfo
Retrieves information about the ExportVersion setting parameter.
GetImportCreaseAngleInfo
Retrieves information about the ImportCreaseAngle setting parameter.
GetImportUnitInfo
Retrieves information about the ImportUnit setting parameter.
SetExportBackgroundColor
Sets the ExportBackgroundColor parameter (Background color of exported Vrml files).
SetExportBackgroundColorLock
Locks or unlocks the ExportBackgroundColor setting parameter.
SetExportEdgesLock
Locks or unlocks the ExportEdges setting parameter.
SetExportNormalsLock
Locks or unlocks the ExportNormals setting parameter.
SetExportTextureFileLock
Locks or unlocks the ExportTextureFile setting parameter.
SetExportTextureFormatLock
Locks or unlocks the ExportTextureFormat setting parameter.
SetExportTextureLock
Locks or unlocks the ExportTexture setting parameter.
SetExportVersionLock
Locks or unlocks the ExportVersion setting parameter.
SetImportCreaseAngleLock
Locks or unlocks the ImportCreaseAngle setting parameter.
SetImportUnitLock
Locks or unlocks the ImportLock setting parameter.
Properties
Property ExportEdges() As
Returns or sets the ExportEdges parameter (exported Vrml files will or will not contains edge informations).
Parameters:
oExportEdges
- iExportEdges	Value of ExportEdges parameter.
Legal values:
TRUE  :   exported Vrml files will contain edge informations.
FALSE :   exported Vrml files will not contain edge informations.
Property ExportNormals() As
Returns or sets the ExportNormals parameter (exported Vrml files will or will not contains normal informations).
Parameters:
oExportNormals
- iExportNormals	Value of ExportNormals parameter.
Legal values:
TRUE  :   exported Vrml files will contain normal informations.
FALSE :   exported Vrml files will not contain normal informations.
Property ExportTexture() As
Returns or sets the ExportTexture parameter (exported Vrml files will or will not contains texture informations).
Parameters:
oExportTexture
- iExportTexture	Value of ExportTexture parameter.
Legal values:
TRUE  :   exported Vrml files will contain texture informations.
FALSE :   exported Vrml files will not contain texture informations.
Property ExportTextureFile() As
Returns or sets the ExportTextureFile parameter (Textures will be exported in the vrml file containing the geometry
or in external files).
Parameters:
oExportTextureFile
- 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.
Property ExportTextureFormat() As
Returns or sets the ExportTextureFormat parameter.
Parameters:
oExportTextureFormat
- iExportTextureFormat Value of ExportTextureFormat parameter.
Legal values:
NOT APPLICABLE
Property ExportVersion() As
Returns or sets the ExportVersion parameter (version of exported Vrml files).
Parameters:
oExportVersion
- iExportVersion	Value of Import Unit parameter.
Legal values:
1 :   VRML 1.0.
2 :   VRML 97 (VRML 2.0).
Property ImportCreaseAngle() As
Returns or 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:
oImportCreaseAngle
- iImportCreaseAngle	Value of ImportCreaseAngle parameter.
Legal values:
[0,inf]
Property ImportUnit() As
Returns or sets the ImportUnit parameter (unit of imported Vrml files).
Parameters:
oImportUnit
- iImportUnit	Value of Import Unit parameter.
Legal values:
0 :   Millimeter.
1 :   Centimeter.
2 :   Meter.
Methods
Sub GetExportBackgroundColor( ioR, ioG, ioB)
Returns the ExportBackgroundColor parameter (Background color of exported Vrml files).
Value of ExportBackgroundColor parameter.
Legal values:
R [0,255] G [0,255] B [0,255]
Func GetExportBackgroundColorInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ExportBackgroundColor setting parameter.
Refer to
for a detailed description.
Func GetExportEdgesInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ExportEdges setting parameter.
Refer to
for a detailed description.
Func GetExportNormalsInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ExportNormals setting parameter.
Refer to
for a detailed description.
Func GetExportTextureFileInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ExportTextureFile setting parameter.
Refer to
for a detailed description.
Func GetExportTextureFormatInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ExportTextureFormat setting parameter.
Refer to
for a detailed description.
Func GetExportTextureInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ExportTexture setting parameter.
Refer to
for a detailed description.
Func GetExportVersionInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ExportVersion setting parameter.
Refer to
for a detailed description.
Func GetImportCreaseAngleInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ImportCreaseAngle setting parameter.
Refer to
for a detailed description.
Func GetImportUnitInfo( ioAdminLevel, ioLocked) As
Retrieves information about the ImportUnit setting parameter.
Refer to
for a detailed description.
Sub SetExportBackgroundColor( iR, iG, iB)
Sets the ExportBackgroundColor parameter (Background color of exported Vrml files).
Value of ExportBackgroundColor parameter.
Legal values:
R [0,255] G [0,255] B [0,255]
Sub SetExportBackgroundColorLock( iLocked)
Locks or unlocks the ExportBackgroundColor setting parameter.
Refer to
for a detailed description.
Sub SetExportEdgesLock( iLocked)
Locks or unlocks the ExportEdges setting parameter.
Refer to
for a detailed description.
Sub SetExportNormalsLock( iLocked)
Locks or unlocks the ExportNormals setting parameter.
Refer to
for a detailed description.
Sub SetExportTextureFileLock( iLocked)
Locks or unlocks the ExportTextureFile setting parameter.
Refer to
for a detailed description.
Sub SetExportTextureFormatLock( iLocked)
Locks or unlocks the ExportTextureFormat setting parameter.
Refer to
for a detailed description.
Sub SetExportTextureLock( iLocked)
Locks or unlocks the ExportTexture setting parameter.
Refer to
for a detailed description.
Sub SetExportVersionLock( iLocked)
Locks or unlocks the ExportVersion setting parameter.
Refer to
for a detailed description.
Sub SetImportCreaseAngleLock( iLocked)
Locks or unlocks the ImportCreaseAngle setting parameter.
Refer to
for a detailed description.
Sub SetImportUnitLock( iLocked)
Locks or unlocks the ImportLock setting parameter.
Refer to
for a detailed description.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Window_13485 ===
InfInterfaces Window (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Window (Object)
Represents the window.
The window is the object that accommodates one or several viewers
to display your objects,
and which makes the link with the windowing system.
Property Index
ActiveViewer
Returns the active viewer in the window.
Caption
Returns or sets the window caption.
Height
Returns or sets the window height.
Left
Returns or sets the distance of the window with respect to the inner
left side of the frame.
PageSetup
Returns or sets the page setup of the window.
Top
Returns or sets the distance of the window with respect to the inner
top side of the frame.
Viewers
Returns the collection of viewers attached to the window.
Width
Returns or sets the window width.
WindowState
Returns or sets the window state.
Method Index
Activate
Activates a window.
ActivateNext
Activates the window following the current active one in the window
collection.
ActivatePrevious
Activates the window preceding the current active one in the window
collection.
Close
Closes the window.
NewWindow
Creates a new window.
PrintOut
Prints the active viewer of the window according to the window's
page setup on the default printer.
PrintToFile
Prints the active viewer of the window according to the window's
page setup in a file instead of being sent to a printer.
Properties
Property ActiveViewer() As   (Read Only)
Returns the active viewer in the window.
Example:
This example retrieves the active viewer in the
CADWindow window in ViewerToWorkIn.
Dim ViewerToWorkIn As Viewer
Set ViewerToWorkIn = CADWindow.ActiveViewer
Property Caption() As
Returns or sets the window caption.
The window caption is displayed in the title bar.
Example:
This example sets the window caption for the CADWindow
window to: CAD 3D Window.
CADWindow.Caption = "CAD 3D Window"
Property Height() As
Returns or sets the window height.
The window height is expressed in pixels.
Example:
This example sets the window height for the CADWindow
window to 300 pixels.
CADWindow.Width = 300
Property Left() As
Returns or sets the distance of the window with respect to the inner
left side of the frame.
This distance is expressed in pixels.
Example:
This example sets the distance of the window with respect to the inner
left side of the frame for the CADWindow window to 150 pixels.
CADWindow.Left = 150
Property PageSetup() As
Returns or sets the page setup of the window.
The page setup includes all parameters to print the window.
Example:
This example sets the page setup for the CADWindow window to
an existing page setup for the A4 paper size A4PageSetup.
CADWindow.PageSetup = A4PageSetup
Property Top() As
Returns or sets the distance of the window with respect to the inner
top side of the frame.
This distance is expressed in pixels.
Example:
This example sets the distance of the window with respect to the inner
top side of the frame for the CADWindow window to 50 pixels.
CADWindow.Top = 50
Property Viewers() As   (Read Only)
Returns the collection of viewers attached to the window.
Example:
This example retrieves the collection of viewers attached to the
CADWindow window in ViewerCollection.
Dim ViewerCollection As Viewers
Set ViewerCollection = CADWindow.Viewers
Property Width() As
Returns or sets the window width.
The window width is expressed in pixels.
Example:
This example sets the window width for the CADWindow
window to 450 pixels.
CADWindow.Width = 450
Property WindowState() As
Returns or sets the window state.
Example:
This example sets the window state for the CADWindow
window to catWindowStateMaximized.
CADWindow.WindowState = catWindowStateMaximized
Methods
Sub Activate()
Activates a window.
The active window is deactivated and the window to which the method
applies is activated instead.
Example:
This example activates the CADWindow window.
CADWindow.Activate()
Sub ActivateNext()
Activates the window following the current active one in the window
collection.
Example:
This example activates the window following the current CADWindow
window in the window collection.
CADWindow.ActivateNext()
Sub ActivatePrevious()
Activates the window preceding the current active one in the window
collection.
Example:
This example activates the window preceding the current CADWindow
window in the window collection.
CADWindow.ActivatePrevious()
Sub Close()
Closes the window.
This method displays the dialog box requesting whether to save the file
if the document was modified, except if
the
property was previously set to False.
Example:
This example closes the CADWindow window.
CADWindow.Close()
Func NewWindow() As
Creates a new window.
The new window displays the same document with the same viewers and viewpoints
than the window to which the method applies, and becomes the active one.
Example:
This example creates a new window named CADNewWindow from
the CADWindow window.
Dim CADNewWindow As Window
Set CADNewWindow = CADWindow.NewWindow()
Sub PrintOut()
Prints the active viewer of the window according to the window's
page setup on the default printer.
Example:
This example prints the CADWindow window's active viewer
on the default printer.
CADWindow.PrintOut()
Sub PrintToFile( fileName)
Prints the active viewer of the window according to the window's
page setup in a file instead of being sent to a printer.
Parameters:
fileName
The full pathname of the file receiving the data.
Example:
This example prints the CADWindow window's active viewer
in a file.
CADWindow.PrintToFile("e:\temp\cadwin.prn")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Windows_14175 ===
InfInterfaces Windows (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Windows (Object)
A collection of all the Window objects currently managed by the
application.
Method Index
Arrange
Arranges all the windows of the collection.
Item
Returns a window using its index or its name from the Windows collection.
Methods
Sub Arrange( iStyle)
Arranges all the windows of the collection.
Parameters:
iStyle
The arrangement style to take into account to arrange the windows
Example:
The following example arranges all the windows in the Windows
collection, according to the catArrangeCascade style.
CATIA.Windows.Arrange(catArrangeCascade)
Func Item( iIndex) As
Returns a window using its index or its name from the Windows collection.
Parameters:
iIndex
The index or the name of the window to retrieve from
the collection of windows.
As a numerics, this index is the rank of the window
in the collection.
The index of the first window in the collection is 1, and
the index of the last window is Count.
As a string, it is the name you assigned to the window using
the
property.
Returns:
The retrieved window
Example:
This example returns in ThisWindow the third window
in the collection, and in ThatWindow the window named
MyWindow.
Dim ThisWindow As Window
Set ThisWindow = CATIA.Windows.Item(3)
Dim ThatWindow As Window
Set ThatWindow = CATIA.Windows.Item("MyWindow")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Workbench_15563 ===
InfInterfaces Workbench (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Workbench (Object)
Represents a workbench on a document.
Role:A workbench is a set of commands that can be used to create, modify
and edit the objects making up the document.
See also:
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.