Atalasoft MobileImage API Reference
Classes | Public Member Functions | List of all members
com.kofax.kmc.ken.engines.data.BoundingTetragon Class Reference

The BoundingTetragon object holds four corner points for a tetragon. This object is serializable. More...

Inheritance diagram for com.kofax.kmc.ken.engines.data.BoundingTetragon:

Classes

enum  Rotation
 

Public Member Functions

 BoundingTetragon ()
 Public Constructors. More...
 
BoundingTetragon clone ()
 Performs a field-for-field copy of instances of this class. More...
 
 BoundingTetragon (int topLeftX, int topLeftY, int topRightX, int topRightY, int bottomLeftX, int bottomLeftY, int bottomRightX, int bottomRightY)
 
 BoundingTetragon (Point topLeft, Point topRight, Point bottomLeft, Point bottomRight)
 
Point getTopLeft ()
 Get the topLeft point. More...
 
void setTopLeft (Point topLeft)
 Set the topLeft point. More...
 
Point getTopRight ()
 Get the topRight point. More...
 
void setTopRight (Point topRight)
 Set the topRight point. More...
 
Point getBottomLeft ()
 Get the bottomLeft point. More...
 
void setBottomLeft (Point bottomLeft)
 Set the bottomLeft point. More...
 
Point getBottomRight ()
 Get the bottomRight point. More...
 
void setBottomRight (Point bottomRight)
 Set the bottomRight point. More...
 
void rotate (int width, int height, Rotation rotation)
 

Detailed Description

The BoundingTetragon object holds four corner points for a tetragon. This object is serializable.

The tetragon consists of the its top-left, top-right, bottom-left, and bottom-right points. These are available through accessor methods.

BoundingTetragon objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.

Constructor & Destructor Documentation

com.kofax.kmc.ken.engines.data.BoundingTetragon.BoundingTetragon ( )
inline

Public Constructors.

Create a new empty BoundingTetragon.

com.kofax.kmc.ken.engines.data.BoundingTetragon.BoundingTetragon ( int  topLeftX,
int  topLeftY,
int  topRightX,
int  topRightY,
int  bottomLeftX,
int  bottomLeftY,
int  bottomRightX,
int  bottomRightY 
)
inline
com.kofax.kmc.ken.engines.data.BoundingTetragon.BoundingTetragon ( Point  topLeft,
Point  topRight,
Point  bottomLeft,
Point  bottomRight 
)
inline

Member Function Documentation

BoundingTetragon com.kofax.kmc.ken.engines.data.BoundingTetragon.clone ( )
inline

Performs a field-for-field copy of instances of this class.

Point com.kofax.kmc.ken.engines.data.BoundingTetragon.getBottomLeft ( )
inline

Get the bottomLeft point.

Point com.kofax.kmc.ken.engines.data.BoundingTetragon.getBottomRight ( )
inline

Get the bottomRight point.

Point com.kofax.kmc.ken.engines.data.BoundingTetragon.getTopLeft ( )
inline

Get the topLeft point.

Point com.kofax.kmc.ken.engines.data.BoundingTetragon.getTopRight ( )
inline

Get the topRight point.

void com.kofax.kmc.ken.engines.data.BoundingTetragon.rotate ( int  width,
int  height,
Rotation  rotation 
)
inline

Given a space in which to rotate, rotate the points in this BoundingTetragon Rotation#LEFT, Rotation#RIGHT or Rotation#FLIP.

Parameters
width
height
rotation
void com.kofax.kmc.ken.engines.data.BoundingTetragon.setBottomLeft ( Point  bottomLeft)
inline

Set the bottomLeft point.

void com.kofax.kmc.ken.engines.data.BoundingTetragon.setBottomRight ( Point  bottomRight)
inline

Set the bottomRight point.

void com.kofax.kmc.ken.engines.data.BoundingTetragon.setTopLeft ( Point  topLeft)
inline

Set the topLeft point.

void com.kofax.kmc.ken.engines.data.BoundingTetragon.setTopRight ( Point  topRight)
inline

Set the topRight point.


The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.