Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
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).
 
bool IsValid () const
 Return true if Tile has been defined.
 
NCollection_Vec2< intOffsetLowerLeft () const
 Return offset position from lower-left corner.
 
Graphic3d_CameraTile Cropped () const
 Return the copy cropped by total size.
 
bool operator== (const Graphic3d_CameraTile &theOther) const
 Equality check.
 
void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
 Dumps the content of me into the stream.
 

Data Fields

NCollection_Vec2< intTotalSize
 total size of the View area, in pixels
 
NCollection_Vec2< intTileSize
 size of the Tile, in pixels
 
NCollection_Vec2< intOffset
 the lower-left corner of the Tile relative to the View area (or upper-left if IsTopDown is true), in pixels
 
bool IsTopDown
 indicate the offset coordinate system - lower-left (default) or top-down
 

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.

◆ DumpJson()

void Graphic3d_CameraTile::DumpJson ( Standard_OStream & theOStream,
int theDepth = -1 ) const

Dumps the content of me into the stream.

◆ IsValid()

bool Graphic3d_CameraTile::IsValid ( ) const
inline

Return true if Tile has been defined.

◆ OffsetLowerLeft()

NCollection_Vec2< int > 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

NCollection_Vec2<int> 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

NCollection_Vec2<int> Graphic3d_CameraTile::TileSize

size of the Tile, in pixels

◆ TotalSize

NCollection_Vec2<int> Graphic3d_CameraTile::TotalSize

total size of the View area, in pixels


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