| SoVectorizeGDIAction Class |
Vectorize a scene graph to MS-Windows GDI formats.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.ActionsSoAction
OIV.HardCopySoVectorizeAction
OIV.HardCopySoVectorizeGDIAction
Namespace: OIV.HardCopy
Assembly: OIV.HardCopy (in OIV.HardCopy.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoVectorizeGDIAction type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVectorizeGDIAction | 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. |
| 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. |
| GetGDIVectorOutput | Returns the OIV.HardCopy.SoGDIVectorOutput instance in action. |
| 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. |
| HasPrinter | Returns true if the printer is set. |
| 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. |
Remarks<font color="#0000FF">[Windows only] This class is not implemented on UNIX systems.</font>
This class is used for vectorizing scene graphs to GDI format outputs. It contains an OIV.HardCopy.SoGDIVectorOutput instance which writes by default to the standard output (printer). Methods on the OIV.HardCopy.SoGDIVectorOutput can be called to specify the output type and its attributes (such as the EMF file name).
NOTE: If margin values are not valid for the targeted printer driver, it will be automatically reset to a correct one by the driver without prompting the user that the resulting output may not be exactly what he expected.
Printer Control: By default this class controls the printer (making the StartDoc, StartPage, etc Windows system calls) and defines the logical to device coordinate system mapping. In some cases the application, or application framework (e.g. MFC) may wish to control the printer directly. This is possible by setting the preference variable OIV_HCGDI_APPCONTROL to a non-zero value, using either a config file or the OIV.Inventor.SoPreferences class. When this variable is non-zero, the application is responsible for calling StartDoc, StartPage, EndPage and EndDoc to manage the printer. There are two modes, depending on the value of OIV_HCGDI_APPCONTROL:
1 : This is the most flexible mode. The application is responsible for setting the map mode, logical to device mapping, etc. (in addition to managing the printer). This mode is normally used in MFC applications.
2 : This is the most convenient mode if you only need to manage the printer. OIV.HardCopy.SoVectorizeGDIAction will set up the mapping as usual. This mode is only available in Open Inventor 7.2 and higher.
NOTE: When OIV_HCGDI_APPCONTROL is set, the methods that take parameters in physical units (e.g. millimeters) actually expect the values in current device units. For example, in this mode most applications call the GDI method SetMapMode() with HI_METRIC, meaning that device units are now .01 millimeter (provides better resolution for detailed drawings). As a result methods like OIV.HardCopy.SoVectorizeAction.SetDrawingDimensions(System.Single, System.Single, OIV.HardCopy.SoVectorizeAction.DimensionUnits) and setNominalWidth must now be called with HI_METRIC units. For 1 mm, pass the value 100.
Polygon edge width: GDI uses a "brush" to draw the interior of a polygon and a "pen" to draw the edges of the polygon. By default the action uses a minimum width line for the polygon edges, but it is possible to specify the edge width by setting the environment variable OIV_HCGDI_EDGE_WIDTH (see OIV.Inventor.SoPreferences). Zero means minimum width. Values > 0 are a scale factor applied to the "nominalWidth" (see OIV.HardCopy.SoVectorizeAction.SetNominalWidth(System.Single, OIV.HardCopy.SoVectorizeAction.DimensionUnits)) similar to the line width set with OIV.Inventor.Nodes.SoDrawStyle.lineWidth. This value is fetched in the constructor so it must be set before creating an OIV.HardCopy.SoVectorizeGDIAction.
Limitations:
End line style TRIANGULAR is not supported end line style ROUND is assumed instead.
Join line style NONE, MITERED_BEVELED, and TRIANGULAR are not supported; join line styles BEVELED, MITERED, and ROUNDED are assumed instead.
End and Join line styles are only supported for solid lines.
User's DC must be of HDC type.
Vertical text orientation may not be kept when editing .emf files in third parties applications, for instance MS Word.
A big value for the line width (defined with an OIV.Inventor.Nodes.SoDrawStyle) may result in previewing or printing solid lines though they remain patterned. It depends on how big gaps are in the pattern.
See additional limitations in OIV.HardCopy.SoVectorizeAction.
See Also