Open CASCADE Technology  7.3.1.dev
Public Member Functions | Data Fields
Graphic3d_CameraTile Class Reference

Class defines the area (Tile) inside a view. More...

#include <Graphic3d_CameraTile.hxx>

Public Member Functions

 Graphic3d_CameraTile ()
 Default constructor. Initializes the empty Tile of zero size and lower-left offset orientation. Such Tile is considered uninitialized (invalid). More...
 
bool IsValid () const
 Return true if Tile has been defined. More...
 
Graphic3d_Vec2i OffsetLowerLeft () const
 Return offset position from lower-left corner. More...
 
Graphic3d_CameraTile Cropped () const
 Return the copy cropped by total size. More...
 
bool operator== (const Graphic3d_CameraTile &theOther) const
 Equality check. More...
 

Data Fields

Graphic3d_Vec2i TotalSize
 total size of the View area, in pixels More...
 
Graphic3d_Vec2i TileSize
 size of the Tile, in pixels More...
 
Graphic3d_Vec2i Offset
 the lower-left corner of the Tile relative to the View area (or upper-left if IsTopDown is true), in pixels More...
 
bool IsTopDown
 indicate the offset coordinate system - lower-left (default) or top-down More...
 

Detailed Description

Class defines the area (Tile) inside a view.

Constructor & Destructor Documentation

◆ Graphic3d_CameraTile()

Graphic3d_CameraTile::Graphic3d_CameraTile ( )
inline

Default constructor. Initializes the empty Tile of zero size and lower-left offset orientation. Such Tile is considered uninitialized (invalid).

Member Function Documentation

◆ Cropped()

Graphic3d_CameraTile Graphic3d_CameraTile::Cropped ( ) const
inline

Return the copy cropped by total size.

◆ IsValid()

bool Graphic3d_CameraTile::IsValid ( ) const
inline

Return true if Tile has been defined.

◆ OffsetLowerLeft()

Graphic3d_Vec2i Graphic3d_CameraTile::OffsetLowerLeft ( ) const
inline

Return offset position from lower-left corner.

◆ operator==()

bool Graphic3d_CameraTile::operator== ( const Graphic3d_CameraTile theOther) const
inline

Equality check.

Field Documentation

◆ IsTopDown

bool Graphic3d_CameraTile::IsTopDown

indicate the offset coordinate system - lower-left (default) or top-down

◆ Offset

Graphic3d_Vec2i Graphic3d_CameraTile::Offset

the lower-left corner of the Tile relative to the View area (or upper-left if IsTopDown is true), in pixels

◆ TileSize

Graphic3d_Vec2i Graphic3d_CameraTile::TileSize

size of the Tile, in pixels

◆ TotalSize

Graphic3d_Vec2i Graphic3d_CameraTile::TotalSize

total size of the View area, in pixels


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