Equalizer  1.7.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
eq::admin::Channel Class Reference
+ Inheritance diagram for eq::admin::Channel:
+ Collaboration diagram for eq::admin::Channel:

Public Member Functions

EQADMIN_API Channel (Window *parent)
 Construct a new channel. More...
 
virtual EQADMIN_API ~Channel ()
 Destruct a channel. More...
 
Data Access
EQADMIN_API Pipe * getPipe ()
 
EQADMIN_API const Pipe * getPipe () const
 
EQADMIN_API Config * getConfig ()
 
EQADMIN_API const Config * getConfig () const
 
EQADMIN_API ServerPtr getServer ()
 
- Public Member Functions inherited from eq::fabric::Channel< Window, Channel >
virtual bool omitOutput () const
 
virtual void output (std::ostream &) const
 
void init ()
 
Window * getWindow ()
 
const Window * getWindow () const
 
bool isDestination () const
 
void setViewVersion (const co::ObjectVersion &view)
 
const co::ObjectVersion & getViewVersion () const
 
void setPixelViewport (const PixelViewport &pvp)
 
EQFABRIC_INL void setViewport (const Viewport &vp)
 
virtual void notifyViewportChanged ()
 
const PixelViewport & getNativePixelViewport () const
 
bool hasFixedViewport () const
 
EQFABRIC_INL void setNearFar (const float nearPlane, const float farPlane)
 Set the near and far planes for this channel. More...
 
uint32_t getDrawable () const
 
EQFABRIC_INL VisitorResult accept (Visitor &visitor)
 Perform a depth-first traversal of this channel. More...
 
EQFABRIC_INL VisitorResult accept (Visitor &visitor) const
 Const-version of accept(). More...
 
EQFABRIC_INL void setCapabilities (const uint64_t bitmask)
 Set the capabilities supported by the channel. More...
 
EQFABRIC_INL uint64_t getCapabilities () const
 
EQFABRIC_INL void setMaxSize (const Vector2i &size)
 
void setOverdraw (const Vector4i &overdraw)
 
const Vector2i & getMaxSize () const
 
EQFABRIC_INL ChannelPath getPath () const
 
virtual EQFABRIC_INL void backup ()
 
virtual EQFABRIC_INL void restore ()
 
uint32_t getDrawBuffer () const
 
uint32_t getReadBuffer () const
 
const ColorMask & getDrawBufferMask () const
 
const PixelViewport & getPixelViewport () const
 
virtual bool useOrtho () const
 Select perspective or orthographic rendering. More...
 
const Frustumf & getFrustum () const
 
const Frustumf & getPerspective () const
 
const Frustumf & getOrtho () const
 
const Matrix4f & getHeadTransform () const
 Return the view matrix. More...
 
const Matrix4f & getPerspectiveTransform () const
 Return the perspective view matrix. More...
 
const Matrix4f & getOrthoTransform () const
 Return the orthographic view matrix. More...
 
const Viewport & getViewport () const
 
const Range & getRange () const
 
const Pixel & getPixel () const
 
const SubPixel & getSubPixel () const
 
const Zoom & getZoom () const
 
uint32_t getPeriod () const
 
uint32_t getPhase () const
 
const Vector2i & getPixelOffset () const
 Get the channel's current position wrt the destination channel. More...
 
Eye getEye () const
 
const Vector4i & getOverdraw () const
 
uint32_t getTaskID () const
 
EQFABRIC_INL int32_t getIAttribute (const IAttribute attr) const
 
EQFABRIC_INL std::string getSAttribute (const SAttribute attr) const
 
- Public Member Functions inherited from eq::fabric::Object
virtual EQFABRIC_API bool isDirty () const
 
virtual EQFABRIC_API uint128_t commit (const uint32_t incarnation=CO_COMMIT_NEXT)
 
virtual EQFABRIC_API void setName (const std::string &name)
 Set the name of the object. More...
 
EQFABRIC_API const std::string & getName () const
 
EQFABRIC_API void setUserData (co::Object *userData)
 Set user-specific data. More...
 
EQFABRIC_API co::Object * getUserData ()
 
EQFABRIC_API const co::Object * getUserData () const
 
EQFABRIC_API uint32_t getTasks () const
 Return the set of tasks this channel might execute in the worst case. More...
 
EQFABRIC_API uint32_t getSerial () const
 

Additional Inherited Members

- Public Types inherited from eq::fabric::Channel< Window, Channel >
enum  Drawable
 The drawable format defines the components used as an alternate drawable for this channel. More...
 
typedef LeafVisitor< Channel > Visitor
 The channel visitor type.
 
typedef Window Parent
 The parent window type.
 
enum  IAttribute
 Integer attributes for a channel. More...
 
enum  SAttribute
 String attributes. More...
 
- Public Types inherited from eq::fabric::Object
enum  DirtyBits {
  DIRTY_NAME = Serializable::DIRTY_CUSTOM << 0, DIRTY_USERDATA = Serializable::DIRTY_CUSTOM << 1, DIRTY_TASKS = Serializable::DIRTY_CUSTOM << 2, DIRTY_REMOVED = Serializable::DIRTY_CUSTOM << 3,
  DIRTY_SERIAL = Serializable::DIRTY_CUSTOM << 4, DIRTY_CUSTOM = Serializable::DIRTY_CUSTOM << 6, DIRTY_OBJECT_BITS = DIRTY_NAME | DIRTY_USERDATA
}
 The changed parts of the object since the last pack(). More...
 
- Static Public Member Functions inherited from eq::fabric::Channel< Window, Channel >
static EQFABRIC_INL const
std::string & 
getIAttributeString (const IAttribute attr)
 
static EQFABRIC_INL const
std::string & 
getSAttributeString (const SAttribute attr)
 
- Protected Types inherited from eq::fabric::Channel< Window, Channel >
enum  DirtyBits
 
- Protected Member Functions inherited from eq::fabric::Channel< Window, Channel >
EQFABRIC_INL Channel (Window *parent)
 Construct a new channel.
 
 Channel (const Channel &from)
 Construct a copy of a channel (view/segment dest).
 
virtual EQFABRIC_INL void serialize (co::DataOStream &os, const uint64_t dirtyBits)
 
virtual EQFABRIC_INL void deserialize (co::DataIStream &is, const uint64_t dirtyBits)
 
virtual EQFABRIC_INL void setDirty (const uint64_t bits)
 
void setDrawable (const uint32_t drawable)
 
void setIAttribute (const IAttribute attr, const int32_t value)
 
void setSAttribute (const SAttribute attr, const std::string &value)
 
virtual ChangeType getChangeType () const
 
virtual uint64_t getRedistributableBits () const
 
virtual void updateCapabilities ()
 
void overrideContext (RenderContext &context)
 
void resetContext ()
 
const RenderContext & getContext () const
 
const RenderContext & getNativeContext () const
 
- Protected Member Functions inherited from eq::fabric::Object
EQFABRIC_API Object ()
 Construct a new Object. More...
 
EQFABRIC_API Object (const Object &)
 Construct an unmapped, unregistered copy of an object. More...
 
virtual EQFABRIC_API ~Object ()
 Destruct the object. More...
 
EQFABRIC_API Object & operator= (const Object &from)
 NOP assignment operator. More...
 
virtual bool hasMasterUserData ()
 
virtual uint32_t getUserDataLatency () const
 
EQFABRIC_API void setTasks (const uint32_t tasks)
 
virtual EQFABRIC_API void notifyDetach ()
 
EQFABRIC_API void postRemove (Object *child)
 
virtual void removeChild (const uint128_t &)
 
template<class C , class S >
void commitChild (C *child, S *sender, uint32_t cmd, const uint32_t incarnation)
 
template<class C >
void commitChild (C *child, const uint32_t incarnation)
 
template<class C , class S >
void commitChildren (const std::vector< C * > &children, S *sender, uint32_t cmd, const uint32_t incarnation)
 
template<class C >
void commitChildren (const std::vector< C * > &children, uint32_t cmd, const uint32_t incarnation)
 
template<class C >
void commitChildren (const std::vector< C * > &children, const uint32_t incarnation)
 
template<class C >
void syncChildren (const std::vector< C * > &children)
 
template<class P , class C >
void releaseChildren (const std::vector< C * > &children)
 
EQFABRIC_API bool _cmdSync (co::ICommand &command)
 

Detailed Description

Definition at line 28 of file admin/channel.h.

Constructor & Destructor Documentation

EQADMIN_API eq::admin::Channel::Channel ( Window *  parent)

Construct a new channel.

Version
1.0
virtual EQADMIN_API eq::admin::Channel::~Channel ( )
virtual

Destruct a channel.

Version
1.0

Reimplemented from eq::fabric::Channel< Window, Channel >.

Member Function Documentation

EQADMIN_API Config* eq::admin::Channel::getConfig ( )
Returns
the parent config.
Version
1.0
EQADMIN_API const Config* eq::admin::Channel::getConfig ( ) const
Returns
the parent config.
Version
1.0
EQADMIN_API Pipe* eq::admin::Channel::getPipe ( )
Returns
the parent pipe.
Version
1.0
EQADMIN_API const Pipe* eq::admin::Channel::getPipe ( ) const
Returns
the parent pipe.
Version
1.0
EQADMIN_API ServerPtr eq::admin::Channel::getServer ( )
Returns
the parent server.
Version
1.0

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