| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
TeView Class Reference

A class to deal with views in TerraLib. More...

`#include <TeView.h>`

List of all members.

## Public Member Functions

| TeView (const string &name="", const string &user="", int id=0)
| Constructor.
virtual | ~TeView ()
| Destructor.
virtual int | id ()
| Returns view unique id.
virtual void | id (int id)
| Sets view unique id.
virtual string | name () const
| Returns the view name.
virtual void | name (const string &s)
| Sets the view name.
virtual string | user ()
| Returns the view user name.
virtual void | user (const string &i)
| Sets the view user name.
virtual TeProjection * | projection ()
| Returns the view projection.
virtual void | projection (TeProjection *p)
| Sets the view projection.
virtual bool | isVisible ()
| Returns TRUE if view is visible.
virtual void | isVisible (bool v)
| Sets whether view is visible.
virtual TeBox & | getCurrentBox ()
| Returns the current box.
virtual void | setCurrentBox (const TeBox &b)
| Sets the current box.
virtual int | getCurrentTheme ()
| Returns the current theme id.
virtual void | setCurrentTheme (const int &id)
| Sets the current theme id.
virtual TeViewTree * | root ()
| Returns the view tree where view belongs.
virtual void | add (TeViewNode *node, const bool &updatePriority=true)
| Adds a view node to the view tree.
virtual TeViewNode * | remove (string name)
| Removes a view node through its name from the view tree.
virtual TeViewNode * | remove (int id)
| Removes a view node through its identifier from the view tree.
virtual void | moveUp (TeViewNode *node)
| Moves a node up.
virtual void | moveDown (TeViewNode *node)
| Moves a node down.
virtual TeViewNode * | get (int i)
| Returns a node identified by its position.
virtual TeTheme * | get (string themeName)
| Returns a node identified by its name and version.
virtual void | sort ()
| Sort the themes in the view.
virtual void | swap (unsigned int i, unsigned int j)
| Swap the order of two themes.
virtual void | visibility (int vis)
| Sets the themes visibility.
virtual int | visibility ()
| Returns the themes visibility.
virtual unsigned int | size ()
| Returns the number of themes in the view.
virtual vector< TeViewNode * > & | themes ()
| Returns the vector of themes of the view sorted according to their priorities.
virtual void | connectedId (int id)
| Sets the id of the connected view.
virtual int | connectedId ()
| Returns the id of the connected view.
virtual TeBox | box (bool onlyVisible)

## Detailed Description

A class to deal with views in TerraLib.

A View is a structure that aggregated themes to be visualized or processed in its own projection. Views may belong to a particular user.

See also:
  TeTheme TeViewNode

Examples:

  createTheme.cpp, and rasterSlicing.cpp.

## Constructor & Destructor Documentation

TeView::TeView | ( | const string & | name = `""`,
|  | const string & | user = `""`,
|  | int | id = `0`
| ) |  | `[inline]`

Constructor.

virtual TeView::~TeView | ( |  | ) | `[inline, virtual]`

Destructor.

## Member Function Documentation

virtual void TeView::add | ( | TeViewNode * | node,
|  | const bool & | updatePriority = `true`
| ) |  | `[inline, virtual]`

Adds a view node to the view tree.

Examples:
  createTheme.cpp, and rasterSlicing.cpp.

virtual TeBox TeView::box | ( | bool | onlyVisible | ) | `[inline, virtual]`

Returns the boundary box of the view themes

Parameters:

  onlyVisible | If is true, returns the boundary box of visible themes, otherwise returns the boundary box of all themes

virtual void TeView::connectedId | ( | int | id | ) | `[inline, virtual]`

Sets the id of the connected view.

virtual int TeView::connectedId | ( |  | ) | `[inline, virtual]`

Returns the id of the connected view.

virtual TeViewNode* TeView::get | ( | int | i | ) | `[inline, virtual]`

Returns a node identified by its position.

virtual TeTheme* TeView::get | ( | string | themeName | ) | `[inline, virtual]`

Returns a node identified by its name and version.

virtual TeBox& TeView::getCurrentBox | ( |  | ) | `[inline, virtual]`

Returns the current box.

virtual int TeView::getCurrentTheme | ( |  | ) | `[inline, virtual]`

Returns the current theme id.

virtual int TeView::id | ( |  | ) | `[inline, virtual]`

Returns view unique id.

virtual void TeView::id | ( | int | id | ) | `[inline, virtual]`

Sets view unique id.

virtual bool TeView::isVisible | ( |  | ) | `[inline, virtual]`

Returns TRUE if view is visible.

virtual void TeView::isVisible | ( | bool | v | ) | `[inline, virtual]`

Sets whether view is visible.

virtual void TeView::moveDown | ( | TeViewNode * | node | ) | `[inline, virtual]`

Moves a node down.

virtual void TeView::moveUp | ( | TeViewNode * | node | ) | `[inline, virtual]`

Moves a node up.

virtual void TeView::name | ( | const string & | s | ) | `[inline, virtual]`

Sets the view name.

virtual string TeView::name | ( |  | ) | const`[inline, virtual]`

Returns the view name.

virtual void TeView::projection | ( | TeProjection * | p | ) | `[inline, virtual]`

Sets the view projection.

virtual TeProjection* TeView::projection | ( |  | ) | `[inline, virtual]`

Returns the view projection.

Examples:
  createTheme.cpp, and rasterSlicing.cpp.

virtual TeViewNode* TeView::remove | ( | string | name | ) | `[inline, virtual]`

Removes a view node through its name from the view tree.

virtual TeViewNode* TeView::remove | ( | int | id | ) | `[inline, virtual]`

Removes a view node through its identifier from the view tree.

virtual TeViewTree* TeView::root | ( |  | ) | `[inline, virtual]`

Returns the view tree where view belongs.

virtual void TeView::setCurrentBox | ( | const TeBox & | b | ) | `[inline, virtual]`

Sets the current box.

virtual void TeView::setCurrentTheme | ( | const int & | id | ) | `[inline, virtual]`

Sets the current theme id.

virtual unsigned int TeView::size | ( | void |  | ) | `[inline, virtual]`

Returns the number of themes in the view.

virtual void TeView::sort | ( |  | ) | `[inline, virtual]`

Sort the themes in the view.

virtual void TeView::swap | ( | unsigned int | i,
|  | unsigned int | j
| ) |  | `[inline, virtual]`

Swap the order of two themes.

virtual vector<TeViewNode*>& TeView::themes | ( |  | ) | `[inline, virtual]`

Returns the vector of themes of the view sorted according to their priorities.

virtual string TeView::user | ( |  | ) | `[inline, virtual]`

Returns the view user name.

virtual void TeView::user | ( | const string & | i | ) | `[inline, virtual]`

Sets the view user name.

virtual void TeView::visibility | ( | int | vis | ) | `[inline, virtual]`

Sets the themes visibility.

virtual int TeView::visibility | ( |  | ) | `[inline, virtual]`

Returns the themes visibility.

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeView.h

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines