SoCGMVectorOutput Class Reference

HardCopy Class used to write vector formatted CGM files. More...

#include <HardCopy/SoVectorizeCGMAction.h>

Inheritance diagram for SoCGMVectorOutput:

List of all members.

Public Member Functions

 SoCGMVectorOutput ()
virtual ~SoCGMVectorOutput ()
virtual SoNONUNICODE SbBool openFile (const char *file_name)
virtual SbBool openFile (const SbString &file_name)
void setBinary (SbBool flag=TRUE)
SbBool isBinary () const
void setVersion (int vers=1)
int getVersion () const
void setIndexed (SbBool flag=TRUE)
SbBool isIndexed () const

Detailed Description

HardCopy Class used to write vector formatted CGM files.

This class is used for writing vector formatted files in CGM format. It provides some convenience functions for handling files. An instance of SoCGMVectorOutput is contained in an SoVectorizeCGMAction; this is typically the only instance needed.

The environment variable OIV_CGM_HARDCOPY_BUFSIZE specifies the buffer size in bytes for storing CGM calls before writing them to the disk. The default buffer size is 1048576 bytes (1 megabyte). If set to 1, no buffering is done.

Constructor & Destructor Documentation

SoCGMVectorOutput::SoCGMVectorOutput (  ) 


The default constructor writes to stdout.

virtual SoCGMVectorOutput::~SoCGMVectorOutput (  )  [virtual]


The destructor closes any files opened by the SoCGMVectorOutput.

Member Function Documentation

int SoCGMVectorOutput::getVersion (  )  const [inline]

Gets the version of the output CGM file.

SbBool SoCGMVectorOutput::isBinary (  )  const [inline]

Gets the output mode.

SbBool SoCGMVectorOutput::isIndexed (  )  const [inline]

Gets the color mode.

virtual SbBool SoCGMVectorOutput::openFile ( const SbString file_name  )  [virtual]

Opens named file (sets file pointer to result) .

It returns FALSE on error.

Reimplemented from SoVectorOutput.

virtual SoNONUNICODE SbBool SoCGMVectorOutput::openFile ( const char *  file_name  )  [virtual]

Opens named file (sets file pointer to result) .

It returns FALSE on error.

Non Unicode List:
This function should not be used in a Unicode application.

Reimplemented from SoVectorOutput.

void SoCGMVectorOutput::setBinary ( SbBool  flag = TRUE  )  [inline]

Sets the output mode.

This mode can be clear text encoding or binary mode encoding. The default mode is clear text encoding.

void SoCGMVectorOutput::setIndexed ( SbBool  flag = TRUE  )  [inline]

Sets the color mode.

The default color mode is Indexed and the other mode is Direct (RGB).

void SoCGMVectorOutput::setVersion ( int  vers = 1  )  [inline]

Sets the version of the output CGM file.

The default version is 1.

  • When the version of CGM is less than 3, the setLineEndStyle(), getLineEndStyle(), setLineJoinStyle(), getLineJoinStyle(), setMiterLimit(), and getMiterLimit() methods have no effect on the output.
  • In versions 1 and 2 of CGM, dashed line patterns are default patterns defined by CGM (solid, dash, dot, dash-dot, dash-dot-dot).

The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 18 Apr 2021
Copyright © Thermo Fisher Scientific All rights reserved.