OBJstream Class Reference

An OFstream that keeps track of vertices and provides convenience output methods for OBJ files. More...

Inheritance diagram for OBJstream:
Collaboration diagram for OBJstream:

Public Member Functions

 ClassNameNoDebug ("OBJstream")
 Declare type-name (no debug switch) More...
 
 OBJstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption())
 Construct from pathname (ASCII, uncompressed) More...
 
 OBJstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct from pathname, format (uncompressed) More...
 
 ~OBJstream ()=default
 Destructor. More...
 
label nVertices () const noexcept
 Return the number of vertices written. More...
 
virtual Ostreamwrite (const char c) override
 Write character. More...
 
virtual OstreamwriteQuoted (const char *str, std::streamsize len, const bool quoted=true) override
 Write character/string content, with/without surrounding quotes. More...
 
virtual Ostreamwrite (const char *str) override
 Write character string. More...
 
virtual Ostreamwrite (const word &str) override
 Write word. More...
 
virtual Ostreamwrite (const std::string &str) override
 Write string. More...
 
OstreamwriteComment (const std::string &str)
 Write comment (with '# ' prefix) More...
 
Ostreamwrite (const point &p)
 Write point (vertex) More...
 
Ostreamwrite (const point &p, const vector &n)
 Write point and vector normal ('vn') More...
 
Ostreamwrite (const UList< point > &points)
 Write multiple points. More...
 
Ostreamwrite (const edge &e, const UList< point > &points)
 Write edge as points with line. More...
 
Ostreamwrite (const linePointRef &ln)
 Write line. More...
 
Ostreamwrite (const linePointRef &ln, const vector &n0, const vector &n1)
 Write line with points and vector normals ('vn') More...
 
OstreamwriteLine (const point &p0, const point &p1)
 Write line joining two points. More...
 
Ostreamwrite (const triPointRef &f, const bool lines=true)
 Write triangle as points with lines/filled-polygon. More...
 
OstreamwriteFace (const UList< point > &points, const bool lines=true)
 Write face loop points with lines/filled-polygon. More...
 
Ostreamwrite (const face &f, const UList< point > &points, const bool lines=true)
 Write face as points with lines/filled-polygon. More...
 
Ostreamwrite (const UList< face > &faces, const pointField &points, const bool lines=true)
 Write patch faces as points with lines/filled-polygon. More...
 
Ostreamwrite (const UList< edge > &edges, const UList< point > &points, const bool compact=false)
 Write edges as points with lines. More...
 
Ostreamwrite (const treeBoundBox &bb, const bool lines=true)
 Write tree-bounding box with lines/filled-polygons. More...
 
- Public Member Functions inherited from OFstream
 ClassName ("OFstream")
 Declare type-name (with debug switch) More...
 
 OFstream (std::nullptr_t)
 Construct a null output file stream. More...
 
 OFstream (IOstreamOption::atomicType atomic, const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), IOstreamOption::appendType append=IOstreamOption::NON_APPEND)
 Construct with specified atomic behaviour from pathname, stream option, optional append. More...
 
 OFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), IOstreamOption::appendType append=IOstreamOption::NON_APPEND)
 Construct from pathname and other specifications. More...
 
 OFstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, IOstreamOption::appendType append=IOstreamOption::NON_APPEND)
 Construct from pathname, format (uncompressed), optional append, atomic behaviour as per system default. More...
 
 OFstream (IOstreamOption::atomicType atomic, const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, IOstreamOption::appendType append=IOstreamOption::NON_APPEND)
 Construct with specified atomic behaviour from pathname, format (uncompressed), optional append. More...
 
 ~OFstream ()
 Destructor. Possibly invokes an atomic rename (preference defined during construction) More...
 
virtual const std::ostream & stdStream () const override
 Const access to underlying std::ostream. More...
 
virtual std::ostream & stdStream () override
 Access to underlying std::ostream. More...
 
virtual void rewind ()
 Rewind the stream so that it may be written again. Reopens the file (truncation) More...
 
void print (Ostream &os) const override
 Print stream description. More...
 
virtual const fileNamename () const override
 Read/write access to the name of the stream. More...
 
- Public Member Functions inherited from OSstream
 OSstream (const OSstream &)=default
 Copy construct. More...
 
void operator= (const OSstream &)=delete
 No copy assignment. More...
 
 OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
 Construct wrapper around std::ostream, set stream status. More...
 
 OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct wrapper around std::ostream, set stream status. More...
 
 OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct wrapper around std::ostream, set stream status. More...
 
virtual const fileNamename () const override
 Get the name of the output serial stream. (eg, the name of the Fstream file name) More...
 
virtual ios_base::fmtflags flags () const override
 Get stream flags. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags f) override
 Set stream flags. More...
 
void syncState ()
 Set stream state to match that of the std::ostream. More...
 
virtual bool write (const token &tok) override
 Write token to stream or otherwise handle it. More...
 
virtual Ostreamwrite (const int32_t val) override
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t val) override
 Write int64_t. More...
 
virtual Ostreamwrite (const float val) override
 Write float. More...
 
virtual Ostreamwrite (const double val) override
 Write double. More...
 
virtual Ostreamwrite (const char *data, std::streamsize count) override
 Write binary block. More...
 
virtual OstreamwriteRaw (const char *data, std::streamsize count) override
 Low-level raw binary output. More...
 
virtual bool beginRawWrite (std::streamsize count) override
 Begin marker for low-level raw binary output. More...
 
virtual bool endRawWrite () override
 End marker for low-level raw binary output. More...
 
virtual void indent () override
 Add indentation characters. More...
 
virtual void flush () override
 Flush stream. More...
 
virtual void endl () override
 Add newline and flush stream. More...
 
virtual char fill () const override
 Get the current padding character. More...
 
virtual char fill (const char fillch) override
 Set padding character for formatted field up to field width. More...
 
virtual int width () const override
 Get width of output field. More...
 
virtual int width (const int w) override
 Set width of output field. More...
 
virtual int precision () const override
 Get precision of output field. More...
 
virtual int precision (const int p) override
 Set precision of output field. More...
 
virtual OstreamwriteQuoted (const char *str, std::streamsize len, const bool quoted=true)=0
 Inherit write methods from Ostream. More...
 
virtual OstreamwriteQuoted (const std::string &str, const bool quoted=true)
 Inherit write methods from Ostream. More...
 
- Public Member Functions inherited from Ostream
 Ostream (const Ostream &)=default
 Copy construct. More...
 
virtual ~Ostream ()=default
 Destructor. More...
 
 Ostream (IOstreamOption streamOpt=IOstreamOption())
 Default construct (ASCII, uncompressed), construct with specified stream option. More...
 
 Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format (uncompressed) More...
 
virtual OstreamwriteQuoted (const std::string &str, const bool quoted=true)
 Write string content, with/without surrounding quotes. More...
 
virtual Ostreamwrite (const keyType &kw)
 Write keyType. More...
 
unsigned short indentSize () const noexcept
 Return indent size (spaces per level) More...
 
unsigned short indentSize (unsigned short val) noexcept
 Change indent size (spaces per level), return old value. More...
 
unsigned short indentLevel () const noexcept
 Return the indent level. More...
 
unsigned short indentLevel (unsigned short val) noexcept
 Change the indent level, return old value. More...
 
void incrIndent () noexcept
 Increment the indent level. More...
 
void decrIndent ()
 Decrement the indent level. More...
 
virtual OstreamwriteKeyword (const keyType &kw)
 Write the keyword followed by an appropriate indentation. More...
 
virtual OstreambeginBlock (const keyType &kw)
 Write begin block group with the given name. More...
 
virtual OstreambeginBlock ()
 Write begin block group without a name. More...
 
virtual OstreamendBlock ()
 Write end block group. More...
 
virtual OstreamendEntry ()
 Write end entry (';') followed by newline. More...
 
template<class T >
OstreamwriteEntry (const keyType &key, const T &value)
 Write a keyword/value entry. More...
 
template<class T >
OstreamwriteEntryIfDifferent (const word &key, const T &value1, const T &value2)
 Write a keyword/value entry only when the two values differ. More...
 
Ostreamoperator() () const
 Return a non-const reference to const Ostream. More...
 
unsigned short & indentLevel () noexcept
 Access to indent level. More...
 
unsigned short & indentSize () noexcept
 Access to indent size. More...
 
- Public Member Functions inherited from IOstream
 IOstream (const IOstream &)=default
 Copy construct. More...
 
virtual ~IOstream ()=default
 Destructor. More...
 
 IOstream (IOstreamOption streamOpt=IOstreamOption())
 Default construct (ASCII, uncompressed), construct with specified stream option. More...
 
 IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format, version (compression) More...
 
fileName relativeName () const
 Return the name of the stream relative to the current case. More...
 
virtual bool check (const char *operation) const
 Check IOstream status for given operation. More...
 
bool fatalCheck (const char *operation) const
 Check IOstream status for given operation. More...
 
bool opened () const noexcept
 True if stream has been opened. More...
 
bool closed () const noexcept
 True if stream is closed. More...
 
bool good () const noexcept
 True if next operation might succeed. More...
 
bool eof () const noexcept
 True if end of input seen. More...
 
bool fail () const noexcept
 True if next operation will fail. More...
 
bool bad () const noexcept
 True if stream is corrupted. More...
 
 operator bool () const noexcept
 Return true if the stream has not failed. More...
 
bool operator! () const noexcept
 Return true if the stream has failed. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes associated with the stream. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes associated with the stream. More...
 
void setLabelByteSize (unsigned nbytes) noexcept
 Set the sizeof (label) in bytes associated with the stream. More...
 
void setScalarByteSize (unsigned nbytes) noexcept
 Set the sizeof (scalar) in bytes associated with the stream. More...
 
template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type checkLabelSize () const noexcept
 Check if the label byte-size associated with the stream is the same as the given type. More...
 
template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type checkScalarSize () const noexcept
 Check if the scalar byte-size associated with the stream is the same as the given type. More...
 
label lineNumber () const noexcept
 Const access to the current stream line number. More...
 
label & lineNumber () noexcept
 Non-const access to the current stream line number. More...
 
label lineNumber (const label num) noexcept
 Set the stream line number. More...
 
void setEof () noexcept
 Set stream state as reached 'eof'. More...
 
void setFail () noexcept
 Set stream state as 'failed'. More...
 
void setBad ()
 Set stream state to be 'bad'. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f)
 Set flags of stream. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
 Set flags of given field of stream. More...
 
void unsetf (const ios_base::fmtflags f)
 Unset flags of stream. More...
 
void print (Ostream &os, const int streamState) const
 Print information about the stream state bits. More...
 
InfoProxy< IOstreaminfo () const noexcept
 Return info proxy, used to print IOstream information to a stream. More...
 
- Public Member Functions inherited from IOstreamOption
constexpr IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression. More...
 
constexpr IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
 Construct from components (format, compression, version) More...
 
constexpr IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 Construct from components (format, version, compression) More...
 
 IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
 Copy construct with change of format. More...
 
streamFormat format () const noexcept
 Get the current stream format. More...
 
streamFormat format (const streamFormat fmt) noexcept
 Set the stream format. More...
 
streamFormat format (const word &formatName)
 Set the stream format from string value. More...
 
compressionType compression () const noexcept
 Get the stream compression. More...
 
compressionType compression (const compressionType comp) noexcept
 Set the stream compression. More...
 
compressionType compression (const word &compName)
 Set the stream compression from string value. More...
 
versionNumber version () const noexcept
 Get the stream version. More...
 
versionNumber version (const versionNumber ver) noexcept
 Set the stream version. More...
 
versionNumber version (const token &tok)
 Set the stream version from token. More...
 

Additional Inherited Members

- Public Types inherited from IOstream
enum  streamAccess : char { CLOSED = 0, OPENED }
 Enumeration for stream open/closed state. More...
 
- Public Types inherited from IOstreamOption
enum  streamFormat : char { ASCII = 0, BINARY }
 Data format (ascii | binary) More...
 
enum  compressionType : char { UNCOMPRESSED = 0, COMPRESSED }
 Compression treatment (UNCOMPRESSED | COMPRESSED) More...
 
enum  appendType : char { NON_APPEND = 0, APPEND }
 File appending (NON_APPEND | APPEND) More...
 
enum  atomicType : char { NON_ATOMIC = 0, ATOMIC }
 Atomic operations (output) More...
 
enum  floatFormat : unsigned { general = unsigned(0), fixed = unsigned(std::ios_base::fixed), scientific = unsigned(std::ios_base::scientific) }
 Float formats (eg, time directory name formats) More...
 
- Static Public Member Functions inherited from IOstream
static unsigned int defaultPrecision () noexcept
 Return the default precision. More...
 
static unsigned int defaultPrecision (unsigned int prec) noexcept
 Reset the default precision. More...
 
- Static Public Member Functions inherited from IOstreamOption
static floatFormat floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general)
 Lookup floatFormat enum corresponding to the string (general | fixed | scientific). More...
 
static floatFormat floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general)
 getOrDefault floatFormat from dictionary, warn only on bad enumeration. More...
 
static streamFormat formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII)
 Lookup streamFormat enum corresponding to the string (ascii | binary). More...
 
static streamFormat formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
 getOrDefault streamFormat from dictionary, warn only on bad enumeration. More...
 
static compressionType compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
 The compression enum corresponding to the string. More...
 
static compressionType compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
 getOrDefault compressionType from dictionary, warn only on bad enumeration. More...
 
- Static Public Attributes inherited from IOstream
static unsigned int precision_
 Default precision. More...
 
- Static Public Attributes inherited from IOstreamOption
static const Enum< floatFormatfloatFormatNames
 Names for float formats (general, fixed, scientific) More...
 
static const Enum< streamFormatformatNames
 Stream format names (ascii, binary) More...
 
static const versionNumber currentVersion
 The current version number (2.0) More...
 
- Protected Member Functions inherited from IOstream
void setOpened () noexcept
 Set stream opened. More...
 
void setClosed () noexcept
 Set stream closed. More...
 
void setState (std::ios_base::iostate state) noexcept
 Set stream state. More...
 
void setGood () noexcept
 Set stream state to be good. More...
 
- Protected Attributes inherited from Ostream
unsigned short indentSize_ = 4
 Number of spaces per indent level. More...
 
unsigned short indentLevel_ = 0
 Current indent level. More...
 
- Protected Attributes inherited from IOstream
std::ios_base::iostate ioState_
 Mirror of internal stream io state. More...
 
streamAccess openClosed_
 The stream open/closed state. More...
 
unsigned char sizeofLabel_
 The sizeof (label), possibly read from the header. More...
 
unsigned char sizeofScalar_
 The sizeof (scalar), possibly read from the header. More...
 
label lineNumber_
 The file line. More...
 
- Static Protected Attributes inherited from Ostream
static constexpr const unsigned short entryIndentation_ = 16
 Indentation of the entry from the start of the keyword. More...
 
- Static Protected Attributes inherited from IOstream
static fileName staticName_
 Name for any generic stream - normally treat as readonly. More...
 

Detailed Description

An OFstream that keeps track of vertices and provides convenience output methods for OBJ files.

Source files

Definition at line 55 of file OBJstream.H.

Constructor & Destructor Documentation

◆ OBJstream() [1/2]

OBJstream ( const fileName pathname,
IOstreamOption  streamOpt = IOstreamOption() 
)
explicit

Construct from pathname (ASCII, uncompressed)

Definition at line 56 of file OBJstream.C.

◆ OBJstream() [2/2]

Construct from pathname, format (uncompressed)

Definition at line 97 of file OBJstream.H.

◆ ~OBJstream()

~OBJstream ( )
default

Destructor.

Member Function Documentation

◆ ClassNameNoDebug()

ClassNameNoDebug ( "OBJstream"  )

Declare type-name (no debug switch)

◆ nVertices()

label nVertices ( ) const
inlinenoexcept

Return the number of vertices written.

Definition at line 120 of file OBJstream.H.

◆ write() [1/15]

◆ writeQuoted()

Foam::Ostream & writeQuoted ( const char *  str,
std::streamsize  len,
const bool  quoted = true 
)
overridevirtual

Write character/string content, with/without surrounding quotes.

Reimplemented from OSstream.

Definition at line 78 of file OBJstream.C.

References OSstream::writeQuoted().

Referenced by dynamicCode::copyOrCreateFiles(), dynamicCode::createMakeFiles(), dynamicCode::createMakeOptions(), Foam::operator<<(), decomposedBlockData::writeData(), and dynamicCode::writeDigest().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write() [2/15]

Foam::Ostream & write ( const char *  str)
overridevirtual

Write character string.

Reimplemented from OSstream.

Definition at line 110 of file OBJstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ write() [3/15]

Foam::Ostream & write ( const word str)
overridevirtual

Write word.

Reimplemented from OSstream.

Definition at line 121 of file OBJstream.C.

◆ write() [4/15]

Foam::Ostream & write ( const std::string &  str)
overridevirtual

Write string.

Reimplemented from OSstream.

Definition at line 127 of file OBJstream.C.

◆ writeComment()

Foam::Ostream & writeComment ( const std::string &  str)

Write comment (with '# ' prefix)

Definition at line 133 of file OBJstream.C.

References Foam::constant::universal::c, and OSstream::write().

Here is the call graph for this function:

◆ write() [5/15]

Foam::Ostream & write ( const point p)

Write point (vertex)

Definition at line 176 of file OBJstream.C.

References Foam::nl, p, and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [6/15]

Foam::Ostream & write ( const point p,
const vector n 
)

Write point and vector normal ('vn')

Definition at line 183 of file OBJstream.C.

References n, Foam::nl, p, Foam::vtk::write(), and OSstream::write().

Here is the call graph for this function:

◆ write() [7/15]

Foam::Ostream & write ( const UList< point > &  points)

Write multiple points.

Definition at line 191 of file OBJstream.C.

References Foam::nl, p, points, and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [8/15]

Foam::Ostream & write ( const edge e,
const UList< point > &  points 
)

Write edge as points with line.

Definition at line 201 of file OBJstream.C.

References Foam::constant::electromagnetic::e, Foam::nl, points, and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [9/15]

Foam::Ostream & write ( const linePointRef ln)

Write line.

Definition at line 210 of file OBJstream.C.

References Foam::ln(), Foam::nl, and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [10/15]

Foam::Ostream & write ( const linePointRef ln,
const vector n0,
const vector n1 
)

Write line with points and vector normals ('vn')

Definition at line 220 of file OBJstream.C.

References Foam::ln(), Foam::nl, and Foam::vtk::write().

Here is the call graph for this function:

◆ writeLine()

Foam::Ostream & writeLine ( const point p0,
const point p1 
)

Write line joining two points.

Definition at line 234 of file OBJstream.C.

References Foam::nl, p0, and Foam::vtk::write().

Referenced by averageNeighbourFvGeometryScheme::movePoints(), and extendedEdgeMesh::writeObj().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write() [11/15]

Foam::Ostream & write ( const triPointRef f,
const bool  lines = true 
)

Write triangle as points with lines/filled-polygon.

Definition at line 247 of file OBJstream.C.

References f(), and Foam::vtk::write().

Here is the call graph for this function:

◆ writeFace()

Foam::Ostream & writeFace ( const UList< point > &  points,
const bool  lines = true 
)

Write face loop points with lines/filled-polygon.

Definition at line 279 of file OBJstream.C.

References forAll, points, and Foam::vtk::write().

Referenced by isoAdvection::writeIsoFaces().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write() [12/15]

Foam::Ostream & write ( const face f,
const UList< point > &  points,
const bool  lines = true 
)

Write face as points with lines/filled-polygon.

Definition at line 311 of file OBJstream.C.

References f(), forAll, points, and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [13/15]

Foam::Ostream & write ( const UList< face > &  faces,
const pointField points,
const bool  lines = true 
)

Write patch faces as points with lines/filled-polygon.

Definition at line 346 of file OBJstream.C.

References Foam::constant::electromagnetic::e, PrimitivePatch< FaceList, PointField >::edges(), f(), PrimitivePatch< FaceList, PointField >::localFaces(), PrimitivePatch< FaceList, PointField >::localPoints(), Foam::nl, points, pp(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [14/15]

Foam::Ostream & write ( const UList< edge > &  edges,
const UList< point > &  points,
const bool  compact = false 
)

Write edges as points with lines.

Optionally eliminate unused points.

Definition at line 384 of file OBJstream.C.

References Foam::constant::electromagnetic::e, Foam::nl, points, UList< T >::size(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [15/15]

Foam::Ostream & write ( const treeBoundBox bb,
const bool  lines = true 
)

Write tree-bounding box with lines/filled-polygons.

Definition at line 439 of file OBJstream.C.

References Foam::constant::electromagnetic::e, treeBoundBox::edges, f(), treeBoundBox::faces, Foam::nl, treeBoundBox::points(), and Foam::vtk::write().

Here is the call graph for this function:

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