| SoVectorizeCGMAction Class |
Realizes the vectorization of a scene graph to a file in CGM format.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.ActionsSoAction
OIV.HardCopySoVectorizeAction
OIV.HardCopySoVectorizeCGMAction
Namespace: OIV.HardCopy
Assembly: OIV.HardCopy (in OIV.HardCopy.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe SoVectorizeCGMAction type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVectorizeCGMAction | Constructor. |
Methods| Name | Description | |
|---|---|---|
| Apply(SoNode) | Initiates an action on the graph specified by a node. |
| Apply(SoPath) | Initiates an action on the graph specified by a path. |
| Apply(SoPathList) | Calls Apply(pathList, false). (Inherited from SoVectorizeAction.) |
| Apply(SoPathList, Boolean) | Initiates an action on the graph specified by list of paths. |
| BeginPage(SbVec2f, SbVec2f) | Calls BeginPage(startPagePosition, pageSize, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| BeginPage(SbVec2f, SbVec2f, SoVectorizeActionDimensionUnits) | Begin a new page. |
| ClearApplyResult | When applied, an action may reference nodes or create objects (e.g. |
 | EnableElement | |
| EnableElements | (Overrides SoVectorizeActionEnableElements.) |
| EnableLighting | Allows the user to enable/disable the taking into account of lights in the scene graph during the computation of the vectorized file. |
| EndPage | Ends a page. |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| ForwardTraversal(SoNode) | Traverse a node that is not part of the current scenegraph. |
| ForwardTraversal(SoPath) | Traverse a path that is not part of the current scenegraph. |
| GetBackgroundColor | Returns the color of the background. |
| GetBorder | Returns the color and the width of the border of the clipping limits. |
| GetCGMVectorOutput | Returns the OIV.HardCopy.SoCGMVectorOutput instance in action. |
| GetColorPriority | Returns the color priority. |
| GetColorTranslationMethod | Returns the method for choosing the color of the drawing on the sheet of paper. |
| GetContinueActionInBranchFlag | This function indicates if the action must stop in the current branch. |
| GetCurPath | Returns the path accumulated during traversal, i.e., the chain of nodes from the root of the traversed graph to the current node being traversed. |
| GetDistribMode | Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only). |
| GetDrawingDimensions | Calls GetDrawingDimensions(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| GetDrawingDimensions(SoVectorizeActionDimensionUnits) | Returns the dimensions of the drawing on the sheet of paper. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetHLHSRMode | Returns the Hidden Line and Hidden Surface Removal mode. |
| GetHLHSRRasterCaching | Returns the raster caching flag. |
| GetHLHSRRasterQuality | Returns the raster image quality value. |
| GetLineEndStyle | Returns the style for line ends. |
| GetLineJoinsStyle | Returns the style for line joins. |
| GetLineOffset | Returns line offset. |
| GetLinePatternSize | Calls GetLinePatternSize(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| GetLinePatternSize(SoVectorizeActionDimensionUnits) | Returns the line pattern scale factor. |
| GetMarkerOffset | Returns marker offset. |
| GetMiterLimit | Returns the miter limit. |
| GetNodeAppliedTo | Returns the node the action is being applied to. |
| GetNominalWidth | Calls GetNominalWidth(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| GetNominalWidth(SoVectorizeActionDimensionUnits) | Returns the nominal width. |
| GetOrientation | Returns the orientation of the drawing on the sheet of paper. |
| GetOriginalPathListAppliedTo | Returns the original path list the action is being applied to. |
| GetPathAppliedTo | Returns the path the action is being applied to. |
| GetPathCode | Returns path code based on where current node (the node at the end of the current path) lies with respect to the path(s) the action is being applied to. |
| GetPathListAppliedTo | Returns the path list the action is being applied to. |
| GetPenDescription(SbColor, Single) | Calls GetPenDescription(colors, widths, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| GetPenDescription(SbColor, Single, SoVectorizeActionDimensionUnits) | Returns the description of the color and the width of each pen. |
| GetPenNum | Returns the number of pens. |
| GetPipeId | Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. |
| GetPixelImageSize | Calls GetPixelImageSize(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| GetPixelImageSize(SoVectorizeActionDimensionUnits) | Returns the size of a pixel. |
| GetPolygonOffset | Returns polygon offset. |
| GetSceneManager | Return the OIV.Inventor.SoSceneManager associated with this action. |
| GetShadeModel | Returns the shade model. |
| GetStartPosition | Calls GetStartPosition(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| GetStartPosition(SoVectorizeActionDimensionUnits) | Returns the start position of the drawing on the sheet of paper. |
| GetState | Gets the state from the action. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetVectorOutput | Output access method. |
| GetWhatAppliedTo | Returns code indicating what action is being applied to. |
| HasTerminated | Returns true if the traversal has reached a termination condition. |
| InvalidateState | Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied. |
| IsBeingApplied | Returns true if this action is currently being applied. |
| IsLastPathListAppliedTo | Returns true if the current list is the last one from the original. |
| IsLightingEnabled | Returns true if lighting is enabled. |
| IsUsingAlternateRep | Returns true if current action is using alternate representations. |
| PostDelayedTraversal | Method called by SoMultiPassManager after delayed pass traversals. |
| PreDelayedTraversal | Method called by SoMultiPassManager before delayed pass traversals. |
| ResetContinueActionInBranchFlag | This function resets the continue action flag. |
| SetBackgroundColor(Boolean) | Enables or disables the background and sets its color to white. |
| SetBackgroundColor(Boolean, SbColor) | Sets the color of the background. |
| SetBorder(Single) | Sets the width of the border of the clipping limits. |
| SetBorder(Single, SbColor) | Sets the color and the width of the border of the clipping limits. |
| SetColorPriority | Sets the color priority flag. |
| SetColorTranslationMethod | Sets the method for choosing the color of the drawing on the sheet of paper. |
| SetDrawingDimensions(SbVec2f) | Calls SetDrawingDimensions(d, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetDrawingDimensions(Single, Single) | Calls SetDrawingDimensions(w, h, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetDrawingDimensions(SbVec2f, SoVectorizeActionDimensionUnits) | Sets the dimensions of the drawing on the sheet of paper. |
| SetDrawingDimensions(Single, Single, SoVectorizeActionDimensionUnits) | Sets the dimensions of the drawing on the sheet of paper. |
| SetHLHSRMode | Sets the Hidden Line and Hidden Surface Removal mode. |
| SetHLHSRRasterCaching | Enables/disables the use of OpenGL display lists to generate the raster image with the OIV.HardCopy.SoVectorizeAction.HLHSRModes.HLHSR_RASTER algorithm. |
| SetHLHSRRasterQuality | Sets the quality of the raster image generated to vectorize visible primitives with the OIV.HardCopy.SoVectorizeAction.HLHSRModes.HLHSR_RASTER algorithm. |
| SetLineEndStyle | Sets the style for line ends. |
| SetLineJoinsStyle | Sets the style for line joins. |
| SetLineOffset | Sets line offset. |
| SetLinePatternSize(Single) | Calls SetLinePatternSize(w, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetLinePatternSize(Single, SoVectorizeActionDimensionUnits) | Sets the line pattern size, i.e., the association between printer pattern (16 printer "points") and the size of the line pattern on the hard copy output. |
| SetMarkerOffset | Sets marker offset. |
| SetMiterLimit | Sets the miter limit. |
| SetNominalWidth(Single) | Calls SetNominalWidth(w, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetNominalWidth(Single, SoVectorizeActionDimensionUnits) | Sets the nominal width. |
| SetOrientation | Sets the orientation of the drawing on the sheet of paper. |
| SetPenDescription | Calls SetPenDescription((cli.array<OIV.Inventor.SbColor>^)nullptr, (cli.array<System.Single>^)nullptr, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetPenDescription(SbColor) | Calls SetPenDescription(colors, (cli.array<System.Single>^)nullptr, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetPenDescription(SbColor, Single) | Calls SetPenDescription(colors, widths, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetPenDescription(SbColor, Single, SoVectorizeActionDimensionUnits) | Sets the description of the color and the width of each pen. |
| SetPipeId | Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. |
| SetPixelImageSize(Single) | Calls SetPixelImageSize(w, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetPixelImageSize(Single, SoVectorizeActionDimensionUnits) | Sets the size of a pixel for image primitives. |
| SetPolygonOffset | Method to set the Z offset to be applied to polygons in normalized device coordinates (-1 to 1 space). |
| SetSceneManager | Set the scene manager associated with this action (if any ). |
| SetShadeModel | Selects OIV.HardCopy.SoVectorizeAction.ShadeModels.FLAT or OIV.HardCopy.SoVectorizeAction.ShadeModels.SMOOTH shading. |
| SetStartPosition(SbVec2f) | Calls SetStartPosition(p, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetStartPosition(Single, Single) | Calls SetStartPosition(x, y, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )). (Inherited from SoVectorizeAction.) |
| SetStartPosition(SbVec2f, SoVectorizeActionDimensionUnits) | Sets the start position of the drawing on the sheet of paper. |
| SetStartPosition(Single, Single, SoVectorizeActionDimensionUnits) | Sets the start position of the drawing on the sheet of paper. |
| SetUpState | Creates state if it is NULL or it is no longer valid because new elements have been enabled since it was created. |
| StopActionInBranch | This function stops the action in the current Scene Graph branch. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Traverse | Does traversal of a graph rooted by a node. |
| UseAlternateRep | Tell the action to use alternate representations during traversal when available. |
RemarksThis class is used for vectorizing scene graphs to CGM format files. It contains an OIV.HardCopy.SoCGMVectorOutput instance which writes by default to standard output. Methods on OIV.HardCopy.SoCGMVectorOutput can be called to specify what file to write to.
Limitations:
OIV.HardCopy.SoVectorizeAction.SetOrientation(OIV.HardCopy.SoVectorizeAction.Orientations) has no effect for CGM format.
The orientation is translator dependent.
See additional limitations in OIV.HardCopy.SoVectorizeAction.
See Also