SoVectorizePSAction(3)

📦 version 3.1.3, in fedora 43, fedora 44

🦋 SoVectorizePSAction(3) — Library Functions Manual 🦋

okay so bestie, welcome to the Library Functions Manual entry for SoVectorizePSAction(3) 💖 this is the page you want when you're like "I have a scene graph and I want it to come out the other side as a Postscript file." no cap.

💖 NAME 💖

SoVectorizePSAction — the class that's literally built for rendering to a Postscript file ✨

🌸 SYNOPSIS 🌸

#include <HardCopy/SoVectorizePSAction.h>

Inherits SoVectorizeAction. yes she has a whole ancestry, we'll get to all of it, every single inherited function, don't worry 🫶

🫶 Public Member Functions 🫶

  • virtual SoType getTypeId (void) const — the virtual type-id getter, type-checking icon 💅
  • SoVectorizePSAction (void) — constructor, takes literally nothing, she's low-maintenance
  • virtual ~SoVectorizePSAction () — virtual destructor, cleans up her own mess
  • void setDefault2DFont (const SbString &fontname) — set the default 2D font by name
  • const SbString & getDefault2DFont (void) const — hand back that font name you set
  • void setGouraudThreshold (const double eps) — set the Gouraud threshold, eps is a double
  • SoPSVectorOutput * getOutput (void) const — give me the SoPSVectorOutput pointer pls
  • SoPSVectorOutput * getPSOutput (void) const — same energy, Postscript-flavored name 🎀

🌈 Public Member Functions inherited from SoVectorizeAction 🌈

  • SoVectorizeAction (void) — grandmama constructor
  • virtual ~SoVectorizeAction () — grandmama virtual destructor
  • SoVectorOutput * getOutput (void) const — returns an SoVectorOutput *
  • virtual void apply (SoNode *node) — apply the action to a node
  • virtual void apply (SoPath *path) — apply it to a path
  • virtual void apply (const SoPathList &pathlist, SbBool obeysrules=FALSE) — apply to a whole path list, obeysrules defaults to FALSE
  • void beginStandardPage (const PageSize &pagesize, const float border=10.0f) — kick off a standard page, border defaults to 10.0f
  • virtual void beginPage (const SbVec2f &startpagepos, const SbVec2f &pagesize, DimensionUnit u=MM) — start a page, units default to MM
  • virtual void endPage (void) — done with the page, bye
  • virtual void calibrate (const SbViewportRegion &vp) — calibrate against a viewport region
  • virtual void beginViewport (const SbVec2f &startpos=SbVec2f(-1.0f, 1.0f), const SbVec2f &size=SbVec2f(-1.0f, -1.0f), DimensionUnit u=MM) — open a viewport; defaults are SbVec2f(-1.0f, 1.0f) for startpos, SbVec2f(-1.0f, -1.0f) for size, MM for units
  • virtual void endViewport (void) — close that viewport
  • virtual void setOrientation (Orientation o) — set the orientation
  • virtual Orientation getOrientation (void) const — get the orientation
  • virtual void setBackgroundColor (SbBool bg, const SbColor &col=SbColor(0.0f, 0.0f, 0.0f)) — background on/off plus a color, default black SbColor(0.0f, 0.0f, 0.0f)
  • virtual SbBool getBackgroundColor (SbColor &col) const — reads the background color out into col
  • virtual void setNominalWidth (float w, DimensionUnit u=MM) — set nominal width, units default MM
  • virtual float getNominalWidth (DimensionUnit u=MM) const — get nominal width, units default MM
  • virtual void setPixelImageSize (float w, DimensionUnit u=MM) — set pixel image size, units default MM
  • virtual float getPixelImageSize (DimensionUnit u=MM) const — get pixel image size, units default MM
  • virtual void setPointStyle (const PointStyle &style) — set the point style
  • virtual PointStyle getPointStyle (void) const — get the point style
  • const SbVec2f & getPageStartpos (void) const — where the page starts
  • const SbVec2f & getPageSize (void) const — how big the page is
  • virtual void setDrawingDimensions (const SbVec2f &d, DimensionUnit u=MM) — set drawing dimensions from a vector, units default MM
  • virtual void setDrawingDimensions (float w, float h, DimensionUnit u=MM) — same but with plain w and h floats, units default MM
  • virtual SbVec2f getDrawingDimensions (DimensionUnit u=MM) const — get the drawing dimensions, units default MM
  • virtual void setStartPosition (const SbVec2f &p, DimensionUnit u=MM) — set start position from a vector, units default MM
  • virtual void setStartPosition (float x, float y, DimensionUnit u=MM) — set start position from x/y, units default MM
  • virtual SbVec2f getStartPosition (DimensionUnit u=MM) const — get the start position, units default MM
  • virtual void setColorTranslationMethod (ColorTranslationMethod method) — choose how colors get translated
  • virtual ColorTranslationMethod getColorTranslationMethod (void) const — read that method back
  • virtual void setLineEndStyle (EndLineStyle style) — line end style, set it
  • virtual EndLineStyle getLineEndStyle (void) const — line end style, get it
  • virtual void setLineJoinsStyle (JoinLineStyle style) — line join style, set it
  • virtual JoinLineStyle getLineJoinsStyle (void) const — line join style, get it
  • virtual void setHLHSRMode (HLHSRMode mode) — set the HLHSR mode
  • HLHSRMode getHLHSRMode (void) const — get the HLHSR mode
  • virtual void setBorder (float width) — border width only
  • virtual void setBorder (float width, SbColor color) — border width plus a color
  • virtual void setMiterLimit (float limit) — set the miter limit
  • virtual float getMiterLimit (void) const — get the miter limit
  • virtual void setPenDescription (int num_pens, const SbColor *colors=0, const float *widths=0, DimensionUnit u=MM) — describe your pens: num_pens, optional colors (defaults 0), optional widths (defaults 0), units default MM
  • virtual void getPenDescription (SbColor *colors, float *widths, DimensionUnit u=MM) const — read the pen description back out into colors and widths, units default MM
  • virtual int getPenNum (void) const — how many pens we talking
  • virtual void setColorPriority (SbBool priority) — set color priority
  • virtual SbBool getColorPriority (void) const — get color priority
  • virtual void enableLighting (SbBool flag) — lighting on/off
  • SbBool isLightingEnabled (void) const — is the lighting on tho

🧚 Public Member Functions inherited from SoCallbackAction 🧚

  • SoCallbackAction (void) — constructor, no args
  • SoCallbackAction (const SbViewportRegion &vp) — constructor, but with a viewport region
  • virtual ~SoCallbackAction (void) — virtual destructor
  • void setViewportRegion (const SbViewportRegion &vp) — set the viewport region
  • void addPreCallback (const SoType type, SoCallbackActionCB *cb, void *userdata) — register a pre callback for a type, with cb and userdata
  • void addPostCallback (const SoType type, SoCallbackActionCB *cb, void *userdata) — same but post
  • void addPreTailCallback (SoCallbackActionCB *cb, void *userdata) — pre-tail callback, cb + userdata
  • void addPostTailCallback (SoCallbackActionCB *cb, void *userdata) — post-tail callback, cb + userdata
  • void addTriangleCallback (const SoType type, SoTriangleCB *cb, void *userdata) — triangle callback time 🔺
  • void addLineSegmentCallback (const SoType type, SoLineSegmentCB *cb, void *userdata) — line segment callback time
  • void addPointCallback (const SoType type, SoPointCB *cb, void *userdata) — point callback time
  • SoDecimationTypeElement::Type getDecimationType (void) const — the decimation type getter
  • float getDecimationPercentage (void) const — decimation percentage, as a float
  • float getComplexity (void) const — complexity, as a float
  • SoComplexity::Type getComplexityType (void) const — complexity type
  • int32_t getNumCoordinates (void) const — count the coordinates
  • const SbVec3f & getCoordinate3 (const int index) const — 3D coordinate at index
  • const SbVec4f & getCoordinate4 (const int index) const — 4D coordinate at index
  • SoDrawStyle::Style getDrawStyle (void) const — the draw style
  • unsigned short getLinePattern (void) const — line pattern, unsigned short
  • float getLineWidth (void) const — line width, float
  • float getPointSize (void) const — point size, float
  • const SbName & getFontName (void) const — font name, as an SbName
  • float getFontSize (void) const — font size, float
  • SoLightModel::Model getLightModel (void) const — the light model
  • const SbVec3f & getLightAttenuation (void) const — light attenuation vector
  • void getMaterial (SbColor &ambient, SbColor &diffuse, SbColor &specular, SbColor &emission, float &shininess, float &transparency, const int index=0) const — dump the whole material into ambient, diffuse, specular, emission, shininess, transparency, with index defaulting to 0 💅
  • SoMaterialBinding::Binding getMaterialBinding (void) const — material binding
  • uint32_t getNumNormals (void) const — count the normals
  • const SbVec3f & getNormal (const int index) const — normal at index
  • SoNormalBinding::Binding getNormalBinding (void) const — normal binding
  • int32_t getNumProfileCoordinates (void) const — how many profile coordinates
  • const SbVec2f & getProfileCoordinate2 (const int index) const — 2D profile coordinate at index
  • const SbVec3f & getProfileCoordinate3 (const int index) const — 3D profile coordinate at index
  • const SoNodeList & getProfile (void) const — the profile, as an SoNodeList
  • SoShapeHints::VertexOrdering getVertexOrdering (void) const — vertex ordering
  • SoShapeHints::ShapeType getShapeType (void) const — shape type
  • SoShapeHints::FaceType getFaceType (void) const — face type
  • float getCreaseAngle (void) const — crease angle, float
  • int32_t getNumTextureCoordinates (void) const — texture coordinate count
  • const SbVec2f & getTextureCoordinate2 (const int index) const — 2D texture coordinate at index
  • const SbVec3f & getTextureCoordinate3 (const int index) const — 3D texture coordinate at index
  • const SbVec4f & getTextureCoordinate4 (const int index) const — 4D texture coordinate at index
  • SoTextureCoordinateBinding::Binding getTextureCoordinateBinding (void) const — texture coordinate binding
  • const SbColor & getTextureBlendColor (void) const — texture blend color
  • const unsigned char * getTextureImage (SbVec2s &size, int &numcomps) const — texture image, 2D size version, fills size and numcomps
  • const unsigned char * getTextureImage (SbVec3s &size, int &numcomps) const — texture image, 3D size version, fills size and numcomps
  • const SbMatrix & getTextureMatrix (void) const — texture matrix
  • SoTexture2::Model getTextureModel (void) const — texture model
  • SoTexture2::Wrap getTextureWrapS (void) const — wrap S
  • SoTexture2::Wrap getTextureWrapT (void) const — wrap T
  • SoTexture2::Wrap getTextureWrapR (void) const — wrap R
  • const SbMatrix & getModelMatrix (void) const — model matrix
  • SoUnits::Units getUnits (void) const — units
  • float getFocalDistance (void) const — focal distance, float
  • const SbMatrix & getProjectionMatrix (void) const — projection matrix
  • const SbMatrix & getViewingMatrix (void) const — viewing matrix
  • const SbViewVolume & getViewVolume (void) const — view volume
  • const SbViewportRegion & getViewportRegion (void) const — viewport region
  • SoPickStyle::Style getPickStyle (void) const — pick style
  • int32_t getSwitch (void) const — the switch value
  • Response getCurrentResponse (void) const — current response
  • void invokePreCallbacks (const SoNode *const node) — fire the pre callbacks for node
  • void invokePostCallbacks (const SoNode *const node) — fire the post callbacks for node
  • void invokeTriangleCallbacks (const SoShape *const shape, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3) — fire the triangle callbacks with shape and the three vertices v1, v2, v3
  • void invokeLineSegmentCallbacks (const SoShape *const shape, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2) — fire the line segment callbacks with shape, v1, v2
  • void invokePointCallbacks (const SoShape *const shape, const SoPrimitiveVertex *const v) — fire the point callbacks with shape and v
  • SbBool shouldGeneratePrimitives (const SoShape *shape) const — should we generate primitives for this shape?
  • virtual SoNode * getCurPathTail (void) — the tail of the current path
  • void setCurrentNode (SoNode *const node) — set the current node
  • void setCallbackAll (SbBool callbackall) — set the callbackall flag
  • SbBool isCallbackAll (void) const — is callbackall on?

⭐ Public Member Functions inherited from SoAction ⭐

  • virtual ~SoAction (void) — virtual destructor, top of the family tree
  • virtual SbBool isOfType (SoType type) const — is it this type?
  • void apply (SoAction *beingApplied) — apply with another action
  • virtual void invalidateState (void) — invalidate the state
  • AppliedCode getWhatAppliedTo (void) const — what did it apply to?
  • SoNode * getNodeAppliedTo (void) const — the node it applied to
  • SoPath * getPathAppliedTo (void) const — the path it applied to
  • const SoPathList * getPathListAppliedTo (void) const — the path list it applied to
  • const SoPathList * getOriginalPathListAppliedTo (void) const — the original path list it applied to
  • SbBool isLastPathListAppliedTo (void) const — was it the last path list?
  • PathCode getPathCode (int &numindices, const int *&indices) — path code, fills numindices and indices
  • void traverse (SoNode *const node) — traverse node
  • SbBool hasTerminated (void) const — has it terminated?
  • const SoPath * getCurPath (void) — the current path
  • SoState * getState (void) const — the state
  • PathCode getCurPathCode (void) const — the current path code
  • void usePathCode (int &numindices, const int *&indices) — use a path code with numindices and indices
  • void pushCurPath (const int childindex, SoNode *node=NULL) — push current path with childindex, node defaults to NULL
  • void popCurPath (const PathCode prevpathcode) — pop with the previous path code
  • void pushCurPath (void) — push current path, no args
  • void popPushCurPath (const int childindex, SoNode *node=NULL) — pop then push, childindex and node (default NULL)
  • void popCurPath (void) — pop current path, no args
  • void switchToPathTraversal (SoPath *path) — switch to path traversal
  • void switchToNodeTraversal (SoNode *node) — switch to node traversal

💀 Static Public Member Functions 💀

  • static SoType getClassTypeId (void) — class type id, static flavor
  • static void addMethod (const SoType type, SoActionMethod method) — register a method for a type
  • static void enableElement (const SoType type, const int stackindex) — enable an element at stackindex
  • static void initClass (void) — init the class, iconic

💀 Static Public Member Functions inherited from SoVectorizeAction 💀

  • static SoType getClassTypeId (void) — class type id
  • static void addMethod (const SoType type, SoActionMethod method) — add a method for type
  • static void enableElement (const SoType type, const int stackindex) — enable element at stackindex
  • static void initClass (void) — init the class

💀 Static Public Member Functions inherited from SoCallbackAction 💀

  • static SoType getClassTypeId (void) — class type id
  • static void addMethod (const SoType type, SoActionMethod method) — add a method for type
  • static void enableElement (const SoType type, const int stackindex) — enable element at stackindex
  • static void initClass (void) — init the class

💀 Static Public Member Functions inherited from SoAction 💀

  • static void initClass (void) — init the class
  • static void initClasses (void) — init all the classes, plural, she's thorough
  • static SoType getClassTypeId (void) — class type id
  • static void nullAction (SoAction *action, SoNode *node) — the null action, does exactly what it says on the tin

🙈 Protected Member Functions 🙈

  • virtual const SoEnabledElementsList & getEnabledElements (void) const — the enabled elements list
  • virtual void printHeader (void) const — print the header
  • virtual void printFooter (void) const — print the footer
  • virtual void printBackground (void) const — print the background
  • virtual void printItem (const SoVectorizeItem *item) const — print a single item
  • virtual void printViewport (void) const — print the viewport

🙈 Protected Member Functions inherited from SoVectorizeAction 🙈

  • void setOutput (SoVectorOutput *output) — set the output object
  • virtual float pixelsToUnits (const int pixels) — convert pixels to units, returns a float
  • SbVec2f getRotatedViewportStartpos (void) const — rotated viewport start position
  • SbVec2f getRotatedViewportSize (void) const — rotated viewport size
  • const SbBSPTree & getBSPTree (void) const — the BSP tree

🙈 Protected Member Functions inherited from SoCallbackAction 🙈

  • virtual void beginTraversal (SoNode *node) — begin the traversal at node

🙈 Protected Member Functions inherited from SoAction 🙈

  • SoAction (void) — protected constructor, you don't get to call this one directly bestie
  • virtual void endTraversal (SoNode *node) — end the traversal at node
  • void setTerminated (const SbBool flag) — set the terminated flag
  • virtual SbBool shouldCompactPathList (void) const — should the path list get compacted?

and that's just part one of this absolute unit of a manpage, keep scrolling bestie, there's more 💖✨

🌸 Static Protected Member Functions 🌸

Bestie, these are the static protected function besties that live in the shadows. They're giving "for internal use only" energy, but we still list them because every detail matters, periodt.

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

💫 Static Protected Member Functions inherited from SoVectorizeAction

Same duo, inherited from SoVectorizeAction:

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

💫 Static Protected Member Functions inherited from SoCallbackAction

And again from SoCallbackAction:

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

💫 Static Protected Member Functions inherited from SoAction

And one more time from SoAction:

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

👑 Additional Inherited Members 👑

🎀 Public Types inherited from SoVectorizeAction

  • enum DimensionUnit { INCH, MM, METER }
  • enum Orientation { PORTRAIT, LANDSCAPE }
  • enum PageSize { A0 = 0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10 }
  • enum PointStyle { CIRCLE, SQUARE }
  • enum ColorTranslationMethod { REVERSE_ONLY_BLACK_AND_WHITE, AS_IS, REVERSE }
  • enum JoinLineStyle { NO_JOIN, MITERED_JOIN, MITERED_BEVELED_JOIN, BEVELED_JOIN, TRIANGULAR_JOIN, ROUNDED_JOIN }
  • enum EndLineStyle { BUTT_END, SQUARE_END, TRIANGULAR_END, ROUND_END }
  • enum HLHSRMode { NO_HLHSR, HLHSR_SIMPLE_PAINTER, HLHSR_PAINTER, HLHSR_PAINTER_SURFACE_REMOVAL, HIDDEN_LINES_REMOVAL }

🎀 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 }

🎀 Protected Attributes inherited from SoAction

  • SoState * state
  • SoActionMethodList * traversalMethods

📖 Detailed Description 📖

The SoVectorizePSAction class is used for rendering to a Postscript file. It's giving vector-to-PostScript realness.

Since: Coin 2.1
TGS provides HardCopy support as a separate extension for TGS Inventor.

🛠️ Constructor & Destructor Documentation 🛠️

SoVectorizePSAction::SoVectorizePSAction (void )

Default constructor. No args, just constructor things. ✨

SoVectorizePSAction::~SoVectorizePSAction () [virtual]

Default destructor. Say bye, bestie. 💅

✨ Member Function Documentation ✨

SoType SoVectorizePSAction::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.

Usage example:

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 SoVectorizeAction.

void SoVectorizePSAction::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.

void SoVectorizePSAction::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.

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

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

Reimplemented from SoVectorizeAction.

void SoVectorizePSAction::setDefault2DFont (const SbString & fontname)

Sets the default font name. This font will be used for rendering Text2-nodes which have no Font-nodes preceding them. The default value is "Courier".

const SbString & SoVectorizePSAction::getDefault2DFont (void ) const

Returns the default font name.

See also setDefault2DFont().

void SoVectorizePSAction::setGouraudThreshold (const double eps)

Sets the Gouraud shading threshold. A threshold of 0.0 will disable Gouraud shading. A smaller value will yield more accurate Gouraud shading. Default is 0.1.

Since the postscript language has no support for Gouraud shaded triangles, each triangle will be split into subtriangles approximately of size eps postscript units. One postscript unit is approximately 1/72 inch.

SoPSVectorOutput * SoVectorizePSAction::getOutput (void ) const

Returns the SoPSVectorOutput used by this instance.

SoPSVectorOutput * SoVectorizePSAction::getPSOutput (void ) const

Returns the SoPSVectorOutput used by this instance. Provided for API compatibility with TGS HardCopy support.

void SoVectorizePSAction::printHeader (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.

Implements SoVectorizeAction.

void SoVectorizePSAction::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 from SoVectorizeAction.

void SoVectorizePSAction::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 from SoVectorizeAction.

void SoVectorizePSAction::printItem (const SoVectorizeItem * item) 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 an item.

Implements SoVectorizeAction.

void SoVectorizePSAction::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 from SoVectorizeAction.

📝 Author 📝

Generated automatically by Doxygen for Coin from the source code.

Okay bestie, that's the whole page! This lil manual came from Coin, version 3.1.3, and it's the SoVectorizePSAction(3) page. The footer date didn't show up in this copy, but the source and version are right there. Stay iconic, and may your PostScript always render. 💖✨

📦 where this page comes from