SoVectorizeAction(3)

๐Ÿ“ฆ version 3.1.3, in fedora 43, fedora 44

โœจ NAME โœจ

okay so this is SoVectorizeAction(3), straight out of the Library Functions Manual, and she is the moment ๐Ÿ’…

SoVectorizeAction is the base class for vectorizing Coin scene graphs. That's it, that's the whole job description. She's the blueprint bestie, the mother of the operation โ€” the actual working girls inherit from her (spoiler: SoVectorizePSAction does ๐Ÿ‘€).


๐ŸŒˆ SYNOPSIS ๐ŸŒˆ

#include <HardCopy/SoVectorizeAction.h>
  • Inherits SoCallbackAction ๐Ÿซถ
  • Inherited by SoVectorizePSAction ๐Ÿ‘‘

๐Ÿ‘‘ PUBLIC TYPES ๐Ÿ‘‘

okay so these are the enums she walks in with, no cap:

  • enum DimensionUnit { INCH, MM, METER } โ€” three unit choices, pick your fighter ๐Ÿ’ซ
  • enum Orientation { PORTRAIT, LANDSCAPE } โ€” the classic page-vibe duality ๐ŸŒธ
  • enum PageSize { A0 = 0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10 } โ€” the whole A-list, from A0 = 0 all the way down to A10, she really said "every size is valid" ๐ŸŽ€
  • enum PointStyle { CIRCLE, SQUARE } โ€” dots, but make it a choice โœจ
  • enum ColorTranslationMethod { REVERSE_ONLY_BLACK_AND_WHITE, AS_IS, REVERSE } โ€” literally the three ways to handle color translation, no notes ๐Ÿ”ฅ
  • enum JoinLineStyle { NO_JOIN, MITERED_JOIN, MITERED_BEVELED_JOIN, BEVELED_JOIN, TRIANGULAR_JOIN, ROUNDED_JOIN } โ€” six whole ways for lines to meet at a corner, and every single one of them ate ๐Ÿ’…
  • enum EndLineStyle { BUTT_END, SQUARE_END, TRIANGULAR_END, ROUND_END } โ€” how a line says goodbye, four flavors ๐Ÿฆ‹
  • enum HLHSRMode { NO_HLHSR, HLHSR_SIMPLE_PAINTER, HLHSR_PAINTER, HLHSR_PAINTER_SURFACE_REMOVAL, HIDDEN_LINES_REMOVAL } โ€” the hidden line / hidden surface removal menu, and yes she brought the whole thing ๐Ÿงš

๐Ÿซถ Public Types inherited from SoCallbackAction

  • enum Response { CONTINUE, ABORT, PRUNE }
  • typedef Response SoCallbackActionCB(void *userdata, SoCallbackAction *action, const SoNode *node)

๐Ÿ’œ Public Types inherited from SoAction

  • enum AppliedCode { NODE = 0, PATH = 1, PATH_LIST = 2 }
  • enum PathCode { NO_PATH = 0, IN_PATH = 1, BELOW_PATH = 2, OFF_PATH = 3 }

๐ŸŒธ PUBLIC MEMBER FUNCTIONS ๐ŸŒธ

okay bestie, deep breath, this is the big one. Every single one of these is here, I did not skip a single icon:

  • virtual SoType getTypeId (void) const โ€” tells you who she is at runtime, main character identification โœจ
  • SoVectorizeAction (void) โ€” the constructor, she's born ๐Ÿ™ˆ
  • virtual ~SoVectorizeAction () โ€” the destructor, she says bye ๐Ÿ˜ญ
  • SoVectorOutput * getOutput (void) const โ€” hands you back the SoVectorOutput *, she's generous like that ๐Ÿ’–
  • virtual void apply (SoNode *node) โ€” run it on a node
  • virtual void apply (SoPath *path) โ€” run it on a path
  • virtual void apply (const SoPathList &pathlist, SbBool obeysrules=FALSE) โ€” run it on a whole path list, and note the obeysrules default is FALSE ๐Ÿ‘€
  • void beginStandardPage (const PageSize &pagesize, const float border=10.0f) โ€” standard page time, border defaults to 10.0f ๐ŸŽ€
  • virtual void beginPage (const SbVec2f &startpagepos, const SbVec2f &pagesize, DimensionUnit u=MM) โ€” starts a page, unit defaults to MM
  • virtual void endPage (void) โ€” page over, that's a wrap ๐Ÿ’…
  • virtual void calibrate (const SbViewportRegion &vp) โ€” calibration moment
  • virtual void beginViewport (const SbVec2f &startpos=SbVec2f(-1.0f, 1.0f), const SbVec2f &size=SbVec2f(-1.0f, -1.0f), DimensionUnit u=MM) โ€” starts a viewport, and look at those defaults: startpos is SbVec2f(-1.0f, 1.0f), size is SbVec2f(-1.0f, -1.0f), u is MM ๐ŸŒˆ
  • virtual void endViewport (void) โ€” viewport's done, bye girl ๐Ÿฆ‹
  • virtual void setOrientation (Orientation o) โ€” sets the orientation
  • virtual Orientation getOrientation (void) const โ€” reads the orientation back
  • virtual void setBackgroundColor (SbBool bg, const SbColor &col=SbColor(0.0f, 0.0f, 0.0f)) โ€” background color setter, default color is SbColor(0.0f, 0.0f, 0.0f) ๐ŸŒธ
  • virtual SbBool getBackgroundColor (SbColor &col) const โ€” asks about the background color via col
  • virtual void setNominalWidth (float w, DimensionUnit u=MM) โ€” sets nominal width, u defaults to MM
  • virtual float getNominalWidth (DimensionUnit u=MM) const โ€” gets nominal width, u defaults to MM
  • virtual void setPixelImageSize (float w, DimensionUnit u=MM) โ€” pixel image size setter, u defaults to MM
  • virtual float getPixelImageSize (DimensionUnit u=MM) const โ€” pixel image size getter, u defaults to MM
  • virtual void setPointStyle (const PointStyle &style) โ€” sets the point style
  • virtual PointStyle getPointStyle (void) const โ€” gets the point style
  • const SbVec2f & getPageStartpos (void) const โ€” gives you the page start position, by reference ๐Ÿซถ
  • const SbVec2f & getPageSize (void) const โ€” gives you the page size, also by reference
  • virtual void setDrawingDimensions (const SbVec2f &d, DimensionUnit u=MM) โ€” drawing dimensions from an SbVec2f, u defaults to MM
  • virtual void setDrawingDimensions (float w, float h, DimensionUnit u=MM) โ€” drawing dimensions from w and h, u defaults to MM
  • virtual SbVec2f getDrawingDimensions (DimensionUnit u=MM) const โ€” gets drawing dimensions, u defaults to MM
  • virtual void setStartPosition (const SbVec2f &p, DimensionUnit u=MM) โ€” start position from an SbVec2f, u defaults to MM
  • virtual void setStartPosition (float x, float y, DimensionUnit u=MM) โ€” start position from x and y, u defaults to MM
  • virtual SbVec2f getStartPosition (DimensionUnit u=MM) const โ€” gets the start position, u defaults to MM
  • virtual void setColorTranslationMethod (ColorTranslationMethod method) โ€” sets the color translation method
  • virtual ColorTranslationMethod getColorTranslationMethod (void) const โ€” gets the color translation method
  • virtual void setLineEndStyle (EndLineStyle style) โ€” sets the line end style
  • virtual EndLineStyle getLineEndStyle (void) const โ€” gets the line end style
  • virtual void setLineJoinsStyle (JoinLineStyle style) โ€” sets the line joins style (yes, "Joins", that's her name, we respect it ๐Ÿ’…)
  • virtual JoinLineStyle getLineJoinsStyle (void) const โ€” gets the line joins style
  • virtual void setHLHSRMode (HLHSRMode mode) โ€” sets the HLHSR mode
  • HLHSRMode getHLHSRMode (void) const โ€” gets the HLHSR mode, and note she's not virtual, okurrr ๐Ÿ‘€
  • virtual void setBorder (float width) โ€” sets the border width
  • virtual void setBorder (float width, SbColor color) โ€” sets the border width and the color, overachiever โœจ
  • virtual void setMiterLimit (float limit) โ€” sets the miter limit
  • virtual float getMiterLimit (void) const โ€” gets the miter limit
  • virtual void setPenDescription (int num_pens, const SbColor *colors=0, const float *widths=0, DimensionUnit u=MM) โ€” pen description time: num_pens pens, colors defaults to 0, widths defaults to 0, u defaults to MM ๐Ÿ–Š๏ธ
  • virtual void getPenDescription (SbColor *colors, float *widths, DimensionUnit u=MM) const โ€” reads the pen description back out into colors and widths, u defaults to MM
  • virtual int getPenNum (void) const โ€” how many pens, bestie? this tells you ๐Ÿ”ฅ
  • virtual void setColorPriority (SbBool priority) โ€” sets color priority
  • virtual SbBool getColorPriority (void) const โ€” gets color priority
  • virtual void enableLighting (SbBool flag) โ€” flips lighting on or off with flag
  • SbBool isLightingEnabled (void) const โ€” checks if lighting is enabled

๐Ÿ’œ Public Member Functions inherited from SoCallbackAction

  • SoCallbackAction (void)
  • SoCallbackAction (const SbViewportRegion &vp)
  • virtual ~SoCallbackAction (void)
  • void setViewportRegion (const SbViewportRegion &vp)
  • void addPreCallback (const SoType type, SoCallbackActionCB *cb, void *userdata)
  • void addPostCallback (const SoType type, SoCallbackActionCB *cb, void *userdata)
  • void addPreTailCallback (SoCallbackActionCB *cb, void *userdata)
  • void addPostTailCallback (SoCallbackActionCB *cb, void *userdata)
  • void addTriangleCallback (const SoType type, SoTriangleCB *cb, void *userdata)
  • void addLineSegmentCallback (const SoType type, SoLineSegmentCB *cb, void *userdata)
  • void addPointCallback (const SoType type, SoPointCB *cb, void *userdata)
  • SoDecimationTypeElement::Type getDecimationType (void) const
  • float getDecimationPercentage (void) const
  • float getComplexity (void) const
  • SoComplexity::Type getComplexityType (void) const
  • int32_t getNumCoordinates (void) const
  • const SbVec3f & getCoordinate3 (const int index) const
  • const SbVec4f & getCoordinate4 (const int index) const
  • SoDrawStyle::Style getDrawStyle (void) const
  • unsigned short getLinePattern (void) const
  • float getLineWidth (void) const
  • float getPointSize (void) const
  • const SbName & getFontName (void) const
  • float getFontSize (void) const
  • SoLightModel::Model getLightModel (void) const
  • const SbVec3f & getLightAttenuation (void) const
  • void getMaterial (SbColor &ambient, SbColor &diffuse, SbColor &specular, SbColor &emission, float &shininess, float &transparency, const int index=0) const
  • SoMaterialBinding::Binding getMaterialBinding (void) const
  • uint32_t getNumNormals (void) const
  • const SbVec3f & getNormal (const int index) const
  • SoNormalBinding::Binding getNormalBinding (void) const
  • int32_t getNumProfileCoordinates (void) const
  • const SbVec2f & getProfileCoordinate2 (const int index) const
  • const SbVec3f & getProfileCoordinate3 (const int index) const
  • const SoNodeList & getProfile (void) const
  • SoShapeHints::VertexOrdering getVertexOrdering (void) const
  • SoShapeHints::ShapeType getShapeType (void) const
  • SoShapeHints::FaceType getFaceType (void) const
  • float getCreaseAngle (void) const
  • int32_t getNumTextureCoordinates (void) const
  • const SbVec2f & getTextureCoordinate2 (const int index) const
  • const SbVec3f & getTextureCoordinate3 (const int index) const
  • const SbVec4f & getTextureCoordinate4 (const int index) const
  • SoTextureCoordinateBinding::Binding getTextureCoordinateBinding (void) const
  • const SbColor & getTextureBlendColor (void) const
  • const unsigned char * getTextureImage (SbVec2s &size, int &numcomps) const
  • const unsigned char * getTextureImage (SbVec3s &size, int &numcomps) const
  • const SbMatrix & getTextureMatrix (void) const
  • SoTexture2::Model getTextureModel (void) const
  • SoTexture2::Wrap getTextureWrapS (void) const
  • SoTexture2::Wrap getTextureWrapT (void) const
  • SoTexture2::Wrap getTextureWrapR (void) const
  • const SbMatrix & getModelMatrix (void) const
  • SoUnits::Units getUnits (void) const
  • float getFocalDistance (void) const
  • const SbMatrix & getProjectionMatrix (void) const
  • const SbMatrix & getViewingMatrix (void) const
  • const SbViewVolume & getViewVolume (void) const
  • const SbViewportRegion & getViewportRegion (void) const
  • SoPickStyle::Style getPickStyle (void) const
  • int32_t getSwitch (void) const
  • Response getCurrentResponse (void) const
  • void invokePreCallbacks (const SoNode *const node)
  • void invokePostCallbacks (const SoNode *const node)
  • void invokeTriangleCallbacks (const SoShape *const shape, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3)
  • void invokeLineSegmentCallbacks (const SoShape *const shape, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2)
  • void invokePointCallbacks (const SoShape *const shape, const SoPrimitiveVertex *const v)
  • SbBool shouldGeneratePrimitives (const SoShape *shape) const
  • virtual SoNode * getCurPathTail (void)
  • void setCurrentNode (SoNode *const node)
  • void setCallbackAll (SbBool callbackall)
  • SbBool isCallbackAll (void) const

โญ Public Member Functions inherited from SoAction

  • virtual ~SoAction (void)
  • virtual SbBool isOfType (SoType type) const
  • void apply (SoAction *beingApplied)
  • virtual void invalidateState (void)
  • AppliedCode getWhatAppliedTo (void) const
  • SoNode * getNodeAppliedTo (void) const
  • SoPath * getPathAppliedTo (void) const
  • const SoPathList * getPathListAppliedTo (void) const
  • const SoPathList * getOriginalPathListAppliedTo (void) const
  • SbBool isLastPathListAppliedTo (void) const
  • PathCode getPathCode (int &numindices, const int *&indices)
  • void traverse (SoNode *const node)
  • SbBool hasTerminated (void) const
  • const SoPath * getCurPath (void)
  • SoState * getState (void) const
  • PathCode getCurPathCode (void) const
  • void usePathCode (int &numindices, const int *&indices)
  • void pushCurPath (const int childindex, SoNode *node=NULL)
  • void popCurPath (const PathCode prevpathcode)
  • void pushCurPath (void)
  • void popPushCurPath (const int childindex, SoNode *node=NULL)
  • void popCurPath (void)
  • void switchToPathTraversal (SoPath *path)
  • void switchToNodeTraversal (SoNode *node)

๐ŸŒŸ STATIC PUBLIC MEMBER FUNCTIONS ๐ŸŒŸ

the ones you can call without even having an instance, iconic behavior tbh:

  • static SoType getClassTypeId (void)
  • static void addMethod (const SoType type, SoActionMethod method)
  • static void enableElement (const SoType type, const int stackindex)
  • static void initClass (void)

๐Ÿ’œ Static Public Member Functions inherited from SoCallbackAction

  • static SoType getClassTypeId (void)
  • static void addMethod (const SoType type, SoActionMethod method)
  • static void enableElement (const SoType type, const int stackindex)
  • static void initClass (void)

๐ŸŽ€ Static Public Member Functions inherited from SoAction

  • static void initClass (void)
  • static void initClasses (void)
  • static SoType getClassTypeId (void)
  • static void nullAction (SoAction *action, SoNode *node)

๐Ÿซถ PROTECTED MEMBER FUNCTIONS ๐Ÿซถ

the backstage crew, for the subclasses and the brave:

  • virtual const SoEnabledElementsList & getEnabledElements (void) const
  • void setOutput (SoVectorOutput *output)
  • virtual float pixelsToUnits (const int pixels)
  • virtual void printHeader (void) const =0 โ€” pure virtual, so the kids have to implement her, no skipping ๐Ÿ’€
  • virtual void printFooter (void) const
  • virtual void printBackground (void) const
  • virtual void printItem (const SoVectorizeItem *item) const =0 โ€” also pure virtual, also mandatory, also iconic ๐Ÿ”ฅ
  • virtual void printViewport (void) const
  • SbVec2f getRotatedViewportStartpos (void) const
  • SbVec2f getRotatedViewportSize (void) const
  • const SbBSPTree & getBSPTree (void) const

๐Ÿซถ Protected Member Functions inherited from SoCallbackAction ๐Ÿซถ

  • virtual void beginTraversal(SoNode *node) โ€” the hook that fires when traversal kicks off on a node.

๐Ÿซถ Protected Member Functions inherited from SoAction ๐Ÿซถ

  • SoAction(void) โ€” constructor, protected vibes only.
  • virtual void endTraversal(SoNode *node) โ€” called when traversal wraps up on a node.
  • void setTerminated(const SbBool flag) โ€” flips the terminated flag, bestie.
  • virtual SbBool shouldCompactPathList(void) const โ€” decides if the path list should get compacted.

โœจ Static Protected Member Functions โœจ

  • static SoEnabledElementsList * getClassEnabledElements(void) โ€” returns the class's enabled elements list.
  • static SoActionMethodList * getClassActionMethods(void) โ€” returns the class's action methods list.

๐ŸŒˆ Static Protected Member Functions inherited from SoCallbackAction ๐ŸŒˆ

  • static SoEnabledElementsList * getClassEnabledElements(void)
  • static SoActionMethodList * getClassActionMethods(void)

๐ŸŒˆ Static Protected Member Functions inherited from SoAction ๐ŸŒˆ

  • static SoEnabledElementsList * getClassEnabledElements(void)
  • static SoActionMethodList * getClassActionMethods(void)

๐Ÿ’œ Additional Inherited Members ๐Ÿ’œ

Protected Attributes inherited from SoAction

  • SoState * state
  • SoActionMethodList * traversalMethods

๐Ÿ‘‘ Detailed Description ๐Ÿ‘‘

The SoVectorizeAction class is the base class for vectorizing Coin scene graphs. Periodt.

So like, SoVectorizeAction will traverse the scene graph and convert all supported geometry into vectorized data. Then subclasses can take that data and produce vector files in whatever different formats they want. It's giving pipeline energy. ๐Ÿ’…

Currently supported geometry, bestie:

  • Triangles (and polygons will be tessellated, no cap)
  • Line segments
  • Points (can be drawn as circles or squares)
  • 2D text
  • 3D text (will be converted to triangles)
  • Images (from the SoImage node)

The geometry will be shaded based on the OpenGL shading model, so lights and material will affect the geometry in the same way as in a standard Coin viewer. Obsessed with consistency. โœจ

Heads up though: neither transparency nor texture mapping is supported yet. Like, at all. ๐Ÿ˜ญ

Since

Coin 2.1

TGS provides HardCopy support as a separate extension for TGS Inventor.


๐ŸŒธ Member Enumeration Documentation ๐ŸŒธ

enum SoVectorizeAction::DimensionUnit

The unit used by the scene graph. That's it, that's the whole thing.

enum SoVectorizeAction::Orientation

The drawing orientation. ๐Ÿ’ซ

enum SoVectorizeAction::PageSize

The size of the destination page.

Enumerator

  • A0 โ€” 841 x 1189 mm.
  • A1 โ€” 594 x 841 mm.
  • A2 โ€” 420 x 594 mm.
  • A3 โ€” 297 x 420 mm.
  • A4 โ€” 210 x 297 mm.
  • A5 โ€” 148 x 210 mm.
  • A6 โ€” 105 x 148 mm.
  • A7 โ€” 74 x 105 mm.
  • A8 โ€” 52 x 74 mm.
  • A9 โ€” 37 x 52 mm.
  • A10 โ€” 26 x 37 mm.

enum SoVectorizeAction::PointStyle

Enumerates point rendering styles. Lil menu of point vibes.

Enumerator

  • CIRCLE โ€” render points as circles.
  • SQUARE โ€” render points as squares.

๐ŸŽ€ Constructor & Destructor Documentation ๐ŸŽ€

SoVectorizeAction::SoVectorizeAction(void)

Default constructor. Does exactly what it says on the tin. ๐Ÿซถ

SoVectorizeAction::~SoVectorizeAction() [virtual]

Destructor. Say bye bestie. ๐Ÿ‘‹


โญ Member Function Documentation โญ

SoType SoVectorizeAction::getTypeId(void) const [virtual]

Returns the type identification of an action derived from a class inheriting SoAction. This is used for run-time type checking and "downward" casting. iykyk.

Usage example, literally verbatim:

void bar(SoAction * action)
{
  if (action->getTypeId() == SoGLRenderAction::getClassTypeId()) {
    // safe downward cast, know the type
    SoGLRenderAction * glrender = (SoGLRenderAction *)action;
  }
  return; // ignore if not renderaction
}

For application programmers wanting to extend the library with new actions: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through Inventor/nodes/SoSubAction.h: SO_ACTION_SOURCE, SO_ACTION_INIT_CLASS and SO_ACTION_CONSTRUCTOR.

For more information on writing Coin extensions, see the SoAction class documentation.

Returns the actual type id of an object derived from a class inheriting SoAction. Needs to be overridden in all subclasses.

Reimplemented from SoCallbackAction.

Reimplemented in SoVectorizePSAction.

void SoVectorizeAction::addMethod(const SoType type, SoActionMethod method) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Move along, nothing for you here. ๐Ÿ’€

void SoVectorizeAction::enableElement(const SoType type, const int stackindex) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Same deal, bestie.

const SoEnabledElementsList & SoVectorizeAction::getEnabledElements(void) const [protected], [virtual]

Returns a list of the elements used by action instances of this class upon traversal operations.

Reimplemented from SoCallbackAction.

Reimplemented in SoVectorizePSAction.

SoVectorOutput * SoVectorizeAction::getOutput(void) const

Returns the SoVectorOutput class used by this action. The output is written to stdout by default, but you can change this by using SoVectorOutput::openFile(). Iconic lil default ngl.

void SoVectorizeAction::apply(SoNode * root) [virtual]

Applies the action to the scene graph rooted at root.

Note: you should not apply an action to a node with a zero reference count. The behavior in that case is undefined. Like, do not do it. ๐Ÿ™ˆ

Reimplemented from SoAction.

void SoVectorizeAction::apply(SoPath * path) [virtual]

Applies the action to the parts of the graph defined by path.

Note that an SoPath will also contain all nodes that may influence e.g. geometry nodes in the path. So for instance applying an SoGLRenderAction on an SoPath will render that path as expected in the view, where geometry will get its materials, textures, and other appearance settings correctly.

If the path ends in an SoGroup node, the action will also traverse the tail node's children. Sneaky but valid. ๐Ÿ‘‘

Reimplemented from SoAction.

void SoVectorizeAction::apply(const SoPathList & pathlist, SbBool obeysrules = FALSE) [virtual]

Applies action to the graphs defined by pathlist. If obeysrules is set to TRUE, pathlist must obey the following four conditions (which is the case for path lists returned from search actions for non-group nodes and path lists returned from picking actions):

  1. All paths must start at the same head node.
  2. All paths must be sorted in traversal order.
  3. The paths must be unique.
  4. No path can continue through the end point of another path.

See also

SoAction::apply(SoPath * path)

Reimplemented from SoAction.

void SoVectorizeAction::beginPage(const SbVec2f & startpagepos, const SbVec2f & pagesize, DimensionUnit u = MM) [virtual]

Begin writing a page. This will write file header information and print background (if enabled) and border. New page, who dis. โœจ

void SoVectorizeAction::endPage(void) [virtual]

End page. This will write all remaining geometry, and write the file footer. Wrap it up bestie. ๐ŸŽ€

void SoVectorizeAction::calibrate(const SbViewportRegion & vp) [virtual]

Will calibrate pixel based attributes (font size, line width, points size, etc) so that it will match OpenGL rendering done in vp. Matching energy, we love to see it.

See also

setPixelSize()

setNominalWidth()

void SoVectorizeAction::beginViewport(const SbVec2f & start = SbVec2f(-1.0f, 1.0f), const SbVec2f & size = SbVec2f(-1.0f, -1.0f), DimensionUnit u = MM) [virtual]

Begin writing a viewport inside the current page.

See also

beginPage(), endViewport()

void SoVectorizeAction::endViewport(void) [virtual]

End writing a viewport. This will flush all vector items. Cleanup time. ๐Ÿงน

void SoVectorizeAction::setOrientation(Orientation o) [virtual]

Sets the orientation to o.

SoVectorizeAction::Orientation SoVectorizeAction::getOrientation(void) const [virtual]

Returns the current orientation.

See also

setOrientation()

void SoVectorizeAction::setBackgroundColor(SbBool bg, const SbColor & col = SbColor(0.0f, 0.0f, 0.0f)) [virtual]

Sets the background color. If bg is FALSE, the background will not be cleared before rendering. If bg is TRUE, the background will be cleared to col before in beginPage(). Pick your fighter. ๐ŸŒˆ

SbBool SoVectorizeAction::getBackgroundColor(SbColor & col) const [virtual]

Returns if the background will be cleared or not. When this function returns TRUE, col will be set to the background color.

void SoVectorizeAction::setNominalWidth(float w, DimensionUnit u = MM) [virtual]

Sets how to convert pixel based attributes (line width and point size) to vector sizes. By default 1 pixel equals 0.35 mm.

See also

calibrate()

void SoVectorizeAction::setPixelImageSize(float w, DimensionUnit u = MM) [virtual]

Sets how the images and 2D fonts are converted. By default 1 pixel equals 0.35 mm.

See also

calibrate()

float SoVectorizeAction::getPixelImageSize(DimensionUnit u = MM) const [virtual]

Returns the pixel image size.

See also

setPixelImageSize()

void SoVectorizeAction::setPointStyle(const PointStyle & style) [virtual]

Sets the points rendering style. Default style is CIRCLE. ๐Ÿ’ซ

SoVectorizeAction::PointStyle SoVectorizeAction::getPointStyle(void) const [virtual]

Returns the points rendering style.

const SbVec2f & SoVectorizeAction::getPageStartpos(void) const

Returns the current page startpos.

const SbVec2f & SoVectorizeAction::getPageSize(void) const

Returns the current page size.

void SoVectorizeAction::setDrawingDimensions(const SbVec2f & d, DimensionUnit u = MM) [virtual]

Sets the drawing dimensions. You can use this and setStartPosition() instead of using beginViewport(). Provided for TGS OIV compatibility.

๐Ÿ‘€ See also

  • beginViewport()

  • SbVec2f SoVectorizeAction::getDrawingDimensions (DimensionUnit u = MM) const [virtual] โ€” hands you the current drawing dimensions, bestie. That's the tea. โœจ
  • void SoVectorizeAction::setStartPosition (const SbVec2f & p, DimensionUnit u = MM) [virtual] โ€” sets the drawing staring position. You can lowkey use this + setDrawingDimensions() instead of bothering with beginViewport(). Provided for TGS OIV compatibility. ๐Ÿซถ
  • SbVec2f SoVectorizeAction::getStartPosition (DimensionUnit u = MM) const [virtual] โ€” gives you back the current drawing starting position, no cap. ๐Ÿ“
  • void SoVectorizeAction::setColorTranslationMethod (ColorTranslationMethod method) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • SoVectorizeAction::ColorTranslationMethod SoVectorizeAction::getColorTranslationMethod (void ) const [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::setLineEndStyle (EndLineStyle style) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • SoVectorizeAction::EndLineStyle SoVectorizeAction::getLineEndStyle (void ) const [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::setLineJoinsStyle (JoinLineStyle style) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • SoVectorizeAction::JoinLineStyle SoVectorizeAction::getLineJoinsStyle (void ) const [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::setHLHSRMode (HLHSRMode mode) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • SoVectorizeAction::HLHSRMode SoVectorizeAction::getHLHSRMode (void ) const โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::setBorder (float width) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::setBorder (float width, SbColor color) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::setMiterLimit (float limit) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::setPenDescription (int num_pens, const SbColor * colors = 0, const float * widths = 0, DimensionUnit u = MM) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::getPenDescription (SbColor * colors, float * widths, DimensionUnit u = MM) const [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • int SoVectorizeAction::getPenNum (void ) const [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::setColorPriority (SbBool priority) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • SbBool SoVectorizeAction::getColorPriority (void ) const [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • void SoVectorizeAction::enableLighting (SbBool flag) [virtual] โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€
  • SbBool SoVectorizeAction::isLightingEnabled (void ) const โ€” Not implemented yet. Provided for TGS OIV compatibility. ๐Ÿ’€

okay so like half of those are just vibes and promises, but the rest are the real ones ๐Ÿ‘‡

  • void SoVectorizeAction::setOutput (SoVectorOutput * output) [protected] โ€” should be used by subclasses to set the SoVectorOutput instance that should be used. ๐ŸŽ€
  • float SoVectorizeAction::pixelsToUnits (const int pixels) [protected], [virtual] โ€” converts pixels to normalized units. math girlie behaviour fr fr. ๐Ÿงฎ
  • virtual void SoVectorizeAction::printHeader (void ) const [protected], [pure virtual] โ€” this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implemented in SoVectorizePSAction.

  • void SoVectorizeAction::printFooter (void ) const [protected], [virtual] โ€” this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Should be overridden by subclasses to print file footer data. Reimplemented in SoVectorizePSAction.

  • void SoVectorizeAction::printBackground (void ) const [protected], [virtual] โ€” this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Should be overridden by subclasses to print background data. Reimplemented in SoVectorizePSAction.

  • void SoVectorizeAction::printItem (const SoVectorizeItem * item) const [protected], [pure virtual] โ€” this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Should be overridden by subclasses to print an item. Implemented in SoVectorizePSAction.

  • void SoVectorizeAction::printViewport (void ) const [protected], [virtual] โ€” this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Should be overridden by subclasses to set up the current page viewport. Reimplemented in SoVectorizePSAction.

  • SbVec2f SoVectorizeAction::getRotatedViewportStartpos (void ) const [protected] โ€” convenience method for subclasses. Will return the viewport startpos, taking the orientation into account. rotating the whole thing? iconic. ๐Ÿ”„
  • SbVec2f SoVectorizeAction::getRotatedViewportSize (void ) const [protected] โ€” convenience method for subclasses. Will return the viewport size, taking the orientation into account. ๐Ÿ“
  • const SbBSPTree & SoVectorizeAction::getBSPTree (void ) const [protected] โ€” returns the bps tree used to store triangle and line vertices. ๐ŸŒณ (yes bestie, it says bps, we don't make the rules, we just print them ๐Ÿ’…)

โœ๏ธ Author

Generated automatically by Doxygen for Coin from the source code. the machines wrote this one, we just gave it a makeover ๐Ÿ’–


and that's a wrap on SoVectorizeAction(3), bestie!! ๐ŸŽ€ This lil beauty came to you from the Coin source, Version 3.1.3, and honestly? slay. go forth and vectorize responsibly. ๐Ÿฆ‹โœจ

๐Ÿ“ฆ where this page comes from