Equalizer  1.8.0
Parallel Rendering Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
eq::fabric::Equalizer Class Reference

Base data transport class for equalizers. More...

#include <equalizer.h>

+ Collaboration diagram for eq::fabric::Equalizer:

Public Types

enum  Mode { MODE_DB = 0, MODE_HORIZONTAL, MODE_VERTICAL, MODE_2D }
 

Public Member Functions

EQFABRIC_API Equalizer (const Equalizer &rhs)
 
EQFABRIC_API Equalizeroperator= (const Equalizer &rhs)
 
EQFABRIC_API void serialize (co::DataOStream &os) const
 
EQFABRIC_API void deserialize (co::DataIStream &is)
 
EQFABRIC_API void backup ()
 
EQFABRIC_API void restore ()
 
Data Access.
EQFABRIC_API void setFrozen (const bool onOff)
 Set the equalizer to freeze the current state. More...
 
EQFABRIC_API bool isFrozen () const
 
EQFABRIC_API void setMode (const Mode mode)
 Set the load balancer adaptation mode. More...
 
EQFABRIC_API Mode getMode () const
 
EQFABRIC_API void setDamping (const float damping)
 Set the damping factor for the viewport, range or zoom adjustment. More...
 
EQFABRIC_API float getDamping () const
 
EQFABRIC_API void setFrameRate (const float frameRate)
 Set the average frame rate for the DFREqualizer. More...
 
EQFABRIC_API float getFrameRate () const
 
EQFABRIC_API void setBoundary (const Vector2i &boundary)
 Set a boundary for 2D tiles. More...
 
EQFABRIC_API void setBoundary (const float boundary)
 Set a boundary for DB ranges. More...
 
EQFABRIC_API const Vector2i & getBoundary2i () const
 
EQFABRIC_API float getBoundaryf () const
 
EQFABRIC_API void setResistance (const Vector2i &resistance)
 Set a resistance for 2D tiles. More...
 
EQFABRIC_API void setResistance (const float resistance)
 Set a resistance for DB ranges. More...
 
EQFABRIC_API const Vector2i & getResistance2i () const
 
EQFABRIC_API float getResistancef () const
 
EQFABRIC_API void setAssembleOnlyLimit (const float limit)
 Set the limit when to assign assemble tasks only. More...
 
EQFABRIC_API float getAssembleOnlyLimit () const
 
EQFABRIC_API void setTileSize (const Vector2i &size)
 Set the tile size for the TileEqualizer. More...
 
EQFABRIC_API const Vector2i & getTileSize () const
 

Detailed Description

Base data transport class for equalizers.

See also
eq::server::Equalizer

Definition at line 38 of file equalizer.h.

Member Enumeration Documentation

Enumerator
MODE_DB 

Adapt for a sort-last decomposition.

MODE_HORIZONTAL 

Adapt for sort-first using horizontal stripes.

MODE_VERTICAL 

Adapt for sort-first using vertical stripes.

MODE_2D 

Adapt for a sort-first decomposition.

Definition at line 53 of file equalizer.h.

Member Function Documentation

EQFABRIC_API float eq::fabric::Equalizer::getAssembleOnlyLimit ( ) const
Returns
the limit when to assign assemble tasks only.
EQFABRIC_API const Vector2i& eq::fabric::Equalizer::getBoundary2i ( ) const
Returns
the boundary for 2D tiles.
EQFABRIC_API float eq::fabric::Equalizer::getBoundaryf ( ) const
Returns
the boundary for DB ranges.
EQFABRIC_API float eq::fabric::Equalizer::getDamping ( ) const
Returns
the damping factor.
EQFABRIC_API float eq::fabric::Equalizer::getFrameRate ( ) const
Returns
the average frame rate for the DFREqualizer.
EQFABRIC_API Mode eq::fabric::Equalizer::getMode ( ) const
Returns
the load balancer adaptation mode.
EQFABRIC_API const Vector2i& eq::fabric::Equalizer::getResistance2i ( ) const
Returns
the resistance for 2D tiles.
EQFABRIC_API float eq::fabric::Equalizer::getResistancef ( ) const
Returns
the resistance for DB ranges.
EQFABRIC_API const Vector2i& eq::fabric::Equalizer::getTileSize ( ) const
Returns
the tile size for the TileEqualizer.
EQFABRIC_API bool eq::fabric::Equalizer::isFrozen ( ) const
Returns
the equalizer frozen state.
EQFABRIC_API void eq::fabric::Equalizer::setAssembleOnlyLimit ( const float  limit)

Set the limit when to assign assemble tasks only.

EQFABRIC_API void eq::fabric::Equalizer::setBoundary ( const Vector2i &  boundary)

Set a boundary for 2D tiles.

EQFABRIC_API void eq::fabric::Equalizer::setBoundary ( const float  boundary)

Set a boundary for DB ranges.

EQFABRIC_API void eq::fabric::Equalizer::setDamping ( const float  damping)

Set the damping factor for the viewport, range or zoom adjustment.

EQFABRIC_API void eq::fabric::Equalizer::setFrameRate ( const float  frameRate)

Set the average frame rate for the DFREqualizer.

EQFABRIC_API void eq::fabric::Equalizer::setFrozen ( const bool  onOff)

Set the equalizer to freeze the current state.

EQFABRIC_API void eq::fabric::Equalizer::setMode ( const Mode  mode)

Set the load balancer adaptation mode.

EQFABRIC_API void eq::fabric::Equalizer::setResistance ( const Vector2i &  resistance)

Set a resistance for 2D tiles.

EQFABRIC_API void eq::fabric::Equalizer::setResistance ( const float  resistance)

Set a resistance for DB ranges.

EQFABRIC_API void eq::fabric::Equalizer::setTileSize ( const Vector2i &  size)

Set the tile size for the TileEqualizer.


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