CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
CGeomILine Class Reference

Geometry class used to represent 2D vector integer line objects. More...

#include <i_line.h>

Inherits CA2DIShape.

Public Member Functions

 CGeomILine (void)
 Constructor.
 
 ~CGeomILine (void) override
 Destructor.
 
bool bIsPresent (int const, int const)
 Returns true if the point is present in the line.
 
- Public Member Functions inherited from CA2DIShape
CGeom2DIPointoperator[] (int const)
 Returns one integer point from the vector which represents this 2D shape.
 
CGeom2DIPointBack (void)
 Returns the last integer point from the vector which represents this 2D shape.
 
vector< CGeom2DIPoint > * pPtiVGetPoints (void)
 Returns the address of the vector which represents this 2D shape.
 
void Resize (const int)
 Resizes the vector which represents this 2D shape.
 
int nGetSize (void) const
 Returns the number of integer point in the vector which represents this 2D shape.
 
void Append (CGeom2DIPoint const *)
 Appends a new integer point to the vector which represents this 2D shape.
 
void Append (int const, int const)
 Appends a new integer point to the vector which represents this 2D shape.
 
void AppendIfNotAlready (int const, int const)
 Appends a new integer point to the vector which represents this 2D shape, but only if the point is not already present.
 

Protected Member Functions

void Display (void) override
 Instantiates the pure virtual function in the abstract parent class, so that CGeomILine is not an abstract class.
 
- Protected Member Functions inherited from CA2DIShape
 CA2DIShape (void)
 Constructor, no parameters.
 
virtual ~CA2DIShape (void)
 Destructor.
 
void Clear (void)
 Clears the vector which represents this 2D shape.
 

Additional Inherited Members

- Protected Attributes inherited from CA2DIShape
vector< CGeom2DIPointm_VPoints
 The integer points which comprise the integer-coordinate 2D shape.
 

Detailed Description

Geometry class used to represent 2D vector integer line objects.

TODO 001 This is a more detailed description of the CCGeomLine class.

Author
David Favis-Mortlock
Andres Payo
Date
2025

Definition at line 30 of file i_line.h.

Constructor & Destructor Documentation

◆ CGeomILine()

CGeomILine::CGeomILine ( void )

Constructor.

Definition at line 34 of file i_line.cpp.

◆ ~CGeomILine()

CGeomILine::~CGeomILine ( void )
override

Destructor.

Definition at line 39 of file i_line.cpp.

Member Function Documentation

◆ bIsPresent()

bool CGeomILine::bIsPresent ( int const nX,
int const nY )

Returns true if the point is present in the line.

Definition at line 72 of file i_line.cpp.

Referenced by CSimulation::nDoAllShadowZones().

◆ Display()

void CGeomILine::Display ( void )
overrideprotectedvirtual

Instantiates the pure virtual function in the abstract parent class, so that CGeomILine is not an abstract class.

Implements CA2DIShape.

Definition at line 88 of file i_line.cpp.


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