FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Public Member Functions | List of all members
Wizt::FishBundleSavable Class Reference

Convenience class for objects that provide a Bundle that may be saved. More...

#include <FishSaver.hpp>

Inheritance diagram for Wizt::FishBundleSavable:
Wizt::FishSavable

Public Member Functions

 FishBundleSavable (VSaveable *what, VOutput< BundlePtr > &SavableGrid)
 Construction time is used to store the output slot that will be used for saving.
 
FishBait getBait () const override
 Getting the bait from the output grid that was specified during construction.
 
- Public Member Functions inherited from Wizt::FishSavable
 FishSavable (VSaveable *what)
 Constructor creates its own FishWharf and registers a FishSaver on the provided VSaveable.
 

Detailed Description

Convenience class for objects that provide a Bundle that may be saved.

Derive from this class and specify the output bundle slot in the constructor.

Constructor & Destructor Documentation

◆ FishBundleSavable()

Wizt::FishBundleSavable::FishBundleSavable ( VSaveable what,
VOutput< BundlePtr > &  SavableGrid 
)
inline

Construction time is used to store the output slot that will be used for saving.

Note: Only the reference to the output slot is stored here, not another reference pointer. The output slot might actually not yet have been constructed, which is the case when the child class implementing the output grid slot is derived from this class: The base class constructor will be called first (ergo us here), then later will the members be constructed (ergo the parameter that we already use here).

Member Function Documentation

◆ getBait()

FishBait Wizt::FishBundleSavable::getBait ( ) const
overridevirtual

Getting the bait from the output grid that was specified during construction.

Only its global value will be used, local settings not supported.

Implements Wizt::FishSavable.