Click or drag to resize
SoVectorizeHPGLAction Class

Realizes the vectorization of a scene graph to a file in HPGL/2 format.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.ActionsSoAction
      OIV.HardCopySoVectorizeAction
        OIV.HardCopySoVectorizeHPGLAction

Namespace: OIV.HardCopy
Assembly: OIV.HardCopy (in OIV.HardCopy.dll) Version: 2024.1.1.0 (2024.1.1)
Syntax
public class SoVectorizeHPGLAction : SoVectorizeAction

The SoVectorizeHPGLAction type exposes the following members.

Constructors
  NameDescription
Public methodSoVectorizeHPGLAction

Constructor.

Top
Methods
  NameDescription
Public methodApply(SoNode)

Initiates an action on the graph specified by a node.

(Inherited from SoVectorizeAction.)
Public methodApply(SoPath)

Initiates an action on the graph specified by a path.

(Inherited from SoVectorizeAction.)
Public methodApply(SoPathList)
Calls Apply(pathList, false).
(Inherited from SoVectorizeAction.)
Public methodApply(SoPathList, Boolean)

Initiates an action on the graph specified by list of paths.

(Inherited from SoVectorizeAction.)
Public methodBeginPage(SbVec2f, SbVec2f)
Calls BeginPage(startPagePosition, pageSize, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodBeginPage(SbVec2f, SbVec2f, SoVectorizeActionDimensionUnits)

Begin a new page.

(Inherited from SoVectorizeAction.)
Public methodClearApplyResult

When applied, an action may reference nodes or create objects (e.g.

(Inherited from SoAction.)
Public methodStatic memberEnableElement
Public methodEnableElements Obsolete.
Returns the list of enabled elements for a given action subclass.
(Inherited from SoAction.)
Public methodEnableLighting

Allows the user to enable/disable the taking into account of lights in the scene graph during the computation of the vectorized file.

(Inherited from SoVectorizeAction.)
Public methodEndPage

Ends a page.

(Inherited from SoVectorizeAction.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodForwardTraversal(SoNode)

Traverse a node that is not part of the current scenegraph.

(Inherited from SoAction.)
Public methodForwardTraversal(SoPath)

Traverse a path that is not part of the current scenegraph.

(Inherited from SoAction.)
Public methodGetBackgroundColor

Returns the color of the background.

(Inherited from SoVectorizeAction.)
Public methodGetBorder

Returns the color and the width of the border of the clipping limits.

(Inherited from SoVectorizeAction.)
Public methodGetColorPriority

Returns the color priority.

(Inherited from SoVectorizeAction.)
Public methodGetColorTranslationMethod

Returns the method for choosing the color of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodGetContinueActionInBranchFlag

This function indicates if the action must stop in the current branch.

(Inherited from SoAction.)
Public methodGetCurPath

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.

(Inherited from SoAction.)
Public methodGetDistribMode

Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only).

(Inherited from SoAction.)
Public methodGetDrawingDimensions
Calls GetDrawingDimensions(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodGetDrawingDimensions(SoVectorizeActionDimensionUnits)

Returns the dimensions of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetHLHSRMode

Returns the Hidden Line and Hidden Surface Removal mode.

(Inherited from SoVectorizeAction.)
Public methodGetHLHSRRasterCaching

Returns the raster caching flag.

(Inherited from SoVectorizeAction.)
Public methodGetHLHSRRasterQuality

Returns the raster image quality value.

(Inherited from SoVectorizeAction.)
Public methodGetHPGLVectorOutput

Returns the OIV.HardCopy.SoHPGLVectorOutput instance in action.

Public methodGetLineEndStyle

Returns the style for line ends.

(Inherited from SoVectorizeAction.)
Public methodGetLineJoinsStyle

Returns the style for line joins.

(Inherited from SoVectorizeAction.)
Public methodGetLineOffset

Returns line offset.

(Inherited from SoVectorizeAction.)
Public methodGetLinePatternSize
Calls GetLinePatternSize(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodGetLinePatternSize(SoVectorizeActionDimensionUnits)

Returns the line pattern scale factor.

(Inherited from SoVectorizeAction.)
Public methodGetMarkerOffset

Returns marker offset.

(Inherited from SoVectorizeAction.)
Public methodGetMiterLimit

Returns the miter limit.

(Inherited from SoVectorizeAction.)
Public methodGetNodeAppliedTo

Returns the node the action is being applied to.

(Inherited from SoAction.)
Public methodGetNominalWidth
Calls GetNominalWidth(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodGetNominalWidth(SoVectorizeActionDimensionUnits)

Returns the nominal width.

(Inherited from SoVectorizeAction.)
Public methodGetOrientation

Returns the orientation of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodGetOriginalPathListAppliedTo

Returns the original path list the action is being applied to.

(Inherited from SoAction.)
Public methodGetPathAppliedTo

Returns the path the action is being applied to.

(Inherited from SoAction.)
Public methodGetPathCode

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.

(Inherited from SoAction.)
Public methodGetPathListAppliedTo

Returns the path list the action is being applied to.

(Inherited from SoAction.)
Public methodGetPenDescription(SbColor, Single)
Calls GetPenDescription(colors, widths, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodGetPenDescription(SbColor, Single, SoVectorizeActionDimensionUnits)

Returns the description of the color and the width of each pen.

(Inherited from SoVectorizeAction.)
Public methodGetPenNum

Returns the number of pens.

(Inherited from SoVectorizeAction.)
Public methodGetPipeId

Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

(Inherited from SoAction.)
Public methodGetPixelImageSize
Calls GetPixelImageSize(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodGetPixelImageSize(SoVectorizeActionDimensionUnits)

Returns the size of a pixel.

(Inherited from SoVectorizeAction.)
Public methodGetPolygonOffset

Returns polygon offset.

(Inherited from SoVectorizeAction.)
Public methodGetSceneManager

Return the OIV.Inventor.SoSceneManager associated with this action.

(Inherited from SoAction.)
Public methodGetShadeModel

Returns the shade model.

(Inherited from SoVectorizeAction.)
Public methodGetStartPosition
Calls GetStartPosition(OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodGetStartPosition(SoVectorizeActionDimensionUnits)

Returns the start position of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodGetState

Gets the state from the action.

(Inherited from SoAction.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVectorOutput

Output access method.

(Inherited from SoVectorizeAction.)
Public methodGetWhatAppliedTo

Returns code indicating what action is being applied to.

(Inherited from SoAction.)
Public methodHasTerminated

Returns true if the traversal has reached a termination condition.

(Inherited from SoAction.)
Public methodInvalidateState

Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied.

(Inherited from SoAction.)
Public methodIsBeingApplied

Returns true if this action is currently being applied.

(Inherited from SoAction.)
Public methodIsLastPathListAppliedTo

Returns true if the current list is the last one from the original.

(Inherited from SoAction.)
Public methodIsLightingEnabled

Returns true if lighting is enabled.

(Inherited from SoVectorizeAction.)
Public methodIsUsingAlternateRep

Returns true if current action is using alternate representations.

(Inherited from SoAction.)
Public methodPostDelayedTraversal

Method called by SoMultiPassManager after delayed pass traversals.

(Inherited from SoAction.)
Public methodPreDelayedTraversal

Method called by SoMultiPassManager before delayed pass traversals.

(Inherited from SoAction.)
Public methodResetContinueActionInBranchFlag

This function resets the continue action flag.

(Inherited from SoAction.)
Public methodSetBackgroundColor(Boolean)

Enables or disables the background and sets its color to white.

(Inherited from SoVectorizeAction.)
Public methodSetBackgroundColor(Boolean, SbColor)

Sets the color of the background.

(Inherited from SoVectorizeAction.)
Public methodSetBorder(Single)

Sets the width of the border of the clipping limits.

(Inherited from SoVectorizeAction.)
Public methodSetBorder(Single, SbColor)

Sets the color and the width of the border of the clipping limits.

(Inherited from SoVectorizeAction.)
Public methodSetColorPriority

Sets the color priority flag.

(Inherited from SoVectorizeAction.)
Public methodSetColorTranslationMethod

Sets the method for choosing the color of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodSetDrawingDimensions(SbVec2f)
Calls SetDrawingDimensions(d, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetDrawingDimensions(Single, Single)
Calls SetDrawingDimensions(w, h, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetDrawingDimensions(SbVec2f, SoVectorizeActionDimensionUnits)

Sets the dimensions of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodSetDrawingDimensions(Single, Single, SoVectorizeActionDimensionUnits)

Sets the dimensions of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodSetHLHSRMode

Sets the Hidden Line and Hidden Surface Removal mode.

(Inherited from SoVectorizeAction.)
Public methodSetHLHSRRasterCaching

Enables/disables the use of OpenGL display lists to generate the raster image with the OIV.HardCopy.SoVectorizeAction.HLHSRModes.HLHSR_RASTER algorithm.

(Inherited from SoVectorizeAction.)
Public methodSetHLHSRRasterQuality

Sets the quality of the raster image generated to vectorize visible primitives with the OIV.HardCopy.SoVectorizeAction.HLHSRModes.HLHSR_RASTER algorithm.

(Inherited from SoVectorizeAction.)
Public methodSetLineEndStyle

Sets the style for line ends.

(Inherited from SoVectorizeAction.)
Public methodSetLineJoinsStyle

Sets the style for line joins.

(Inherited from SoVectorizeAction.)
Public methodSetLineOffset

Sets line offset.

(Inherited from SoVectorizeAction.)
Public methodSetLinePatternSize(Single)
Calls SetLinePatternSize(w, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetLinePatternSize(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.

(Inherited from SoVectorizeAction.)
Public methodSetMarkerOffset

Sets marker offset.

(Inherited from SoVectorizeAction.)
Public methodSetMiterLimit

Sets the miter limit.

(Inherited from SoVectorizeAction.)
Public methodSetNominalWidth(Single)
Calls SetNominalWidth(w, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetNominalWidth(Single, SoVectorizeActionDimensionUnits)

Sets the nominal width.

(Inherited from SoVectorizeAction.)
Public methodSetOrientation

Sets the orientation of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodSetPenDescription
Calls SetPenDescription((cli.array<OIV.Inventor.SbColor>^)nullptr, (cli.array<System.Single>^)nullptr, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetPenDescription(SbColor)
Calls SetPenDescription(colors, (cli.array<System.Single>^)nullptr, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetPenDescription(SbColor, Single)
Calls SetPenDescription(colors, widths, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetPenDescription(SbColor, Single, SoVectorizeActionDimensionUnits)

Sets the description of the color and the width of each pen.

(Inherited from SoVectorizeAction.)
Public methodSetPipeId

Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

(Inherited from SoAction.)
Public methodSetPixelImageSize(Single)
Calls SetPixelImageSize(w, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetPixelImageSize(Single, SoVectorizeActionDimensionUnits)

Sets the size of a pixel for image primitives.

(Inherited from SoVectorizeAction.)
Public methodSetPolygonOffset

Method to set the Z offset to be applied to polygons in normalized device coordinates (-1 to 1 space).

(Inherited from SoVectorizeAction.)
Public methodSetSceneManager

Set the scene manager associated with this action (if any ).

(Inherited from SoAction.)
Public methodSetShadeModel (Inherited from SoVectorizeAction.)
Public methodSetStartPosition(SbVec2f)
Calls SetStartPosition(p, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetStartPosition(Single, Single)
Calls SetStartPosition(x, y, OIV.HardCopy.SoVectorizeAction.DimensionUnits( .SoVectorizeAction.MM )).
(Inherited from SoVectorizeAction.)
Public methodSetStartPosition(SbVec2f, SoVectorizeActionDimensionUnits)

Sets the start position of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodSetStartPosition(Single, Single, SoVectorizeActionDimensionUnits)

Sets the start position of the drawing on the sheet of paper.

(Inherited from SoVectorizeAction.)
Public methodSetUpState

Creates state if it is NULL or it is no longer valid because new elements have been enabled since it was created.

(Inherited from SoAction.)
Public methodStopActionInBranch

This function stops the action in the current Scene Graph branch.

(Inherited from SoAction.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTraverse

Does traversal of a graph rooted by a node.

(Inherited from SoAction.)
Public methodUseAlternateRep

Tell the action to use alternate representations during traversal when available.

(Inherited from SoAction.)
Top
Remarks

This class is used for vectorizing scene graphs to HPGL/2 format files. It contains an OIV.HardCopy.SoHPGLVectorOutput instance which writes by default to standard output. Methods on OIV.HardCopy.SoHPGLVectorOutput can be called to specify what file to write to.

Limitations:

See Also