Carna/html/Viewport_8h_source.html

/*

 *  Copyright (C) 2010 - 2015 Leonid Kostrykin

 *

 *  Chair of Medical Engineering (mediTEC)

 *  RWTH Aachen University

 *  Pauwelsstr. 20

 *  52074 Aachen

 *  Germany

 *

 */


#ifndef VIEWPORT_H_6014714286

#define VIEWPORT_H_6014714286


#include <Carna/Carna.h>

#include <Carna/base/noncopyable.h>


namespace Carna

{


namespace base

{


// ----------------------------------------------------------------------------------

// Viewport

// ----------------------------------------------------------------------------------


class CARNA_LIB Viewport

{


    NON_COPYABLE


    struct Details;

    const std::unique_ptr< Details > pimpl;


public:


    Viewport( unsigned int rootWidth, unsigned int rootHeight, bool fitSquare );


    explicit Viewport( const Framebuffer& );


    Viewport( const Viewport& parent, unsigned int left, unsigned int top, unsigned int width, unsigned int height );


    ~Viewport();


    void makeActive() const;


    bool isActive() const;


    void done() const;


    void setWidth ( unsigned int );

    void setHeight( unsigned int );


    void setMarginLeft( unsigned int );

    void setMarginTop ( unsigned int );


    unsigned int  width() const;

    unsigned int height() const;


    unsigned int parentWidth () const;

    unsigned int parentHeight() const;


    unsigned int marginLeft  () const;

    unsigned int marginTop   () const;

    unsigned int marginRight () const;

    unsigned int marginBottom() const;


}; // Viewport


}  // namespace Carna :: base


}  // namespace Carna


#endif // VIEWPORT_H_6014714286

Carna::base::Association
Represents an association.
Definition Association.h:45

Carna::base::Framebuffer
Maintains a framebuffer object that supports up to 8 color components simultaneously.
Definition Framebuffer.h:50

Carna::base::Viewport
Defines a rendering viewport. The viewport is a property of the current OpenGL context.
Definition Viewport.h:49

Carna::base::Viewport::marginTop
unsigned int marginTop() const
Tells viewport's top margin.

Carna::base::Viewport::Viewport
Viewport(const Framebuffer &)

Carna::base::Viewport::setHeight
void setHeight(unsigned int)
Sets viewport height.

Carna::base::Viewport::setMarginLeft
void setMarginLeft(unsigned int)
Sets viewport left margin.

Carna::base::Viewport::done
void done() const
Restores the previous viewport.

Carna::base::Viewport::marginRight
unsigned int marginRight() const
Tells viewport's right margin.

Carna::base::Viewport::parentHeight
unsigned int parentHeight() const
Tells parent viewport's height.

Carna::base::Viewport::setWidth
void setWidth(unsigned int)
Sets viewport width.

Carna::base::Viewport::isActive
bool isActive() const
Tells whether this viewport is currently active.

Carna::base::Viewport::marginLeft
unsigned int marginLeft() const
Tells viewport's left margin.

Carna::base::Viewport::setMarginTop
void setMarginTop(unsigned int)
Sets viewport top margin.

Carna::base::Viewport::height
unsigned int height() const
Tells viewport height.

Carna::base::Viewport::Viewport
Viewport(unsigned int rootWidth, unsigned int rootHeight, bool fitSquare)
Creates root viewport.

Carna::base::Viewport::parentWidth
unsigned int parentWidth() const
Tells parent viewport's width.

Carna::base::Viewport::makeActive
void makeActive() const
Makes this viewport the active one of the current OpenGL context.

Carna::base::Viewport::width
unsigned int width() const
Tells viewport width.

Carna::base::Viewport::marginBottom
unsigned int marginBottom() const
Tells viewport's bottom margin.

Carna::base::Viewport::~Viewport
~Viewport()
Restores the parent viewport if this viewport is still active.

Carna::base::Viewport::Viewport
Viewport(const Viewport &parent, unsigned int left, unsigned int top, unsigned int width, unsigned int height)
Derives viewport from parent.

noncopyable.h

NON_COPYABLE
#define NON_COPYABLE
Features class it is placed in as non-copyable.
Definition noncopyable.h:109