W3DStreamWriter Interface Reference

#include "dwf/w3dtk/W3DStreamWriter.h"

Inheritance diagram for W3DStreamWriter:

Inheritance graph
[legend]
Collaboration diagram for W3DStreamWriter:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class manages the interaction among the HSF streamer object, the w3d graphics stream and the op-code handler serialization.

Since:
1.0.1000

Definition at line 79 of file W3DStreamWriter.h.

Public Member Functions

 W3DStreamWriter (DWFOutputStream &rW3DStream, BStreamFileToolkit &rToolkit) throw ()
 ~W3DStreamWriter () throw ()
void open (unsigned int nRequestedVersion=0) throw ( DWFException )
unsigned int close () throw ( DWFException )
void notify (BBaseOpcodeHandler *pHandler, const void *pTag=NULL) throw ( DWFException )


Constructor & Destructor Documentation

W3DStreamWriter::W3DStreamWriter DWFOutputStream rW3DStream,
BStreamFileToolkit rToolkit
throw ()
 

Constructor

Parameters:
rW3DStream The w3d graphics stream.
rToolkit The HSF streamer.
Exceptions:
None 

W3DStreamWriter::~W3DStreamWriter  )  throw ()
 

Destructor

Exceptions:
None 


Member Function Documentation

unsigned int W3DStreamWriter::close  )  throw ( DWFException )
 

Flushes any pending operations and releases all resources.

Returns:
The minimum required stream version number to support the data and options captured in all opcodes. If no such requirement exists the method returns zero.
Exceptions:
DWFException 

void W3DStreamWriter::notify BBaseOpcodeHandler pHandler,
const void *  pTag = NULL
throw ( DWFException ) [virtual]
 

Notification event

Parameters:
pHandler The handler that is being serialized.
pTag An optional identifier for this handler.
Exceptions:
DWFException 

Implements BaseOpcodeHandlerObserver.

void W3DStreamWriter::open unsigned int  nRequestedVersion = 0  )  throw ( DWFException )
 

Prepares the writer for use.

Parameters:
nRequestedVersion An optional parameter that controls the stream format by restricting opcode data and options to a target version number. By default, the latest current version is used.
Exceptions:
DWFException 


The documentation for this interface was generated from the following file:
Generated on Tue Jan 6 22:41:49 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5