SubstreamWrapper Class Reference

#include <ImFusion/Stream/SubstreamWrapper.h>

Generic wrapper class for a Stream to become a substream. More...

Inheritance diagram for SubstreamWrapper:

Detailed Description

Generic wrapper class for a Stream to become a substream.

The SubstreamWrapper owns any custom Stream to serve as a wrapper to add substream functionality to its stream. It takes care of syncing the stream state with the streamGroup proxy stream. The class can be used to bundle multiple individual streams into a StreamGroup.

Public Member Functions
	SubstreamWrapper (std::unique_ptr< Stream > stream, StreamGroupBase *streamGroup)
	Constructor that initializes a SubstreamWrapper with a given Stream and the StreamGroup it should be assigned to.
Stream *	stream () override
	Returns the owned stream that is wrapped into a substream by this wrapper class.
Public Member Functions inherited from SubstreamBase
	SubstreamBase (StreamGroupBase *streamGroup)
StreamGroupBase *	streamGroup () const
	Returns the streamGroup stream group.

Additional Inherited Members
Protected Attributes inherited from SubstreamBase
StreamGroupBase *	m_streamGroup = nullptr

Member Function Documentation

stream()

Stream * stream ( )

overridevirtual

Returns the owned stream that is wrapped into a substream by this wrapper class.

Implements SubstreamBase.

---

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

• ImFusion/Stream/SubstreamWrapper.h