#include <ossimAnnotationLineObject.h>

Inheritance diagram for ossimAnnotationLineObject:

Public Member Functions
	ossimAnnotationLineObject ()

	ossimAnnotationLineObject (const ossimIpt &start, const ossimIpt &end, unsigned char r=255, unsigned char g=255, unsigned char b=255, long thickness=1)

	ossimAnnotationLineObject (long x1, long y1, long x2, long y2, unsigned char r=255, unsigned char g=255, unsigned char b=255, long thickness=1)

	ossimAnnotationLineObject (const ossimAnnotationLineObject &rhs)

virtual ossimObject *	dup () const

virtual void	applyScale (double x, double y)

virtual ossimAnnotationObject *	getNewClippedObject (const ossimDrect &rect) const

virtual bool	intersects (const ossimDrect &rect) const

virtual void	draw (ossimRgbImage &anImage) const

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual void	getBoundingRect (ossimDrect &rect) const

virtual bool	isPointWithin (const ossimDpt &imagePoint) const

virtual void	computeBoundingRect ()

void	setLine (const ossimDpt &start, const ossimDpt &end)

void	getLine (ossimDpt &start, ossimDpt &end)

Public Member Functions inherited from ossimAnnotationObject
virtual	~ossimAnnotationObject ()

	ossimAnnotationObject (ossim_uint8 r=255, ossim_uint8 g=255, ossim_uint8 b=255, ossim_uint8 thickness=1)

virtual void	applyScale (const ossimDpt &scale)

virtual ossimDrect	getBoundingRect () const

virtual void	setColor (ossim_uint8 r, ossim_uint8 g, ossim_uint8 b)

void	getColor (ossim_uint8 &r, ossim_uint8 &g, ossim_uint8 &b) const

ossim_uint8	getThickness () const

virtual void	setThickness (ossim_uint8 thickness)

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Saves the current state of this object. More...

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to the load (recreate) the state of an object from a keyword list. More...

virtual ossimString	getName () const

virtual void	setName (const ossimString &name)

ossim_uint32	getId () const

virtual ossim_uint32	setId ()

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Protected Attributes
ossimIpt	theStart

ossimIpt	theEnd

ossimDrect	theBoundingRect

Protected Attributes inherited from ossimAnnotationObject
ossim_uint8	theRed

ossim_uint8	theGreen

ossim_uint8	theBlue

ossim_uint8	theThickness

ossimString	theName

ossim_uint32	theId

Additional Inherited Members
Static Public Member Functions inherited from ossimAnnotationObject
static ossim_uint32	getNextId ()

static void	restIdCounter ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes inherited from ossimAnnotationObject
static ossim_uint32	theIdCounter = 0

Detailed Description

Definition at line 15 of file ossimAnnotationLineObject.h.

Constructor & Destructor Documentation

◆ ossimAnnotationLineObject() [1/4]

ossimAnnotationLineObject::ossimAnnotationLineObject ( )

Referenced by dup().

◆ ossimAnnotationLineObject() [2/4]

ossimAnnotationLineObject::ossimAnnotationLineObject	(	const ossimIpt &	start,
		const ossimIpt &	end,
		unsigned char	r = `255`,
		unsigned char	g = `255`,
		unsigned char	b = `255`,
		long	thickness = `1`
	)

Definition at line 28 of file ossimAnnotationLineObject.cpp.

References computeBoundingRect().

    :ossimAnnotationObject(r, g, b, thickness),
     theStart(start),
     theEnd(end)
 {
    computeBoundingRect();
 }

◆ ossimAnnotationLineObject() [3/4]

ossimAnnotationLineObject::ossimAnnotationLineObject	(	long	x1,
		long	y1,
		long	x2,
		long	y2,
		unsigned char	r = `255`,
		unsigned char	g = `255`,
		unsigned char	b = `255`,
		long	thickness = `1`
	)

Definition at line 41 of file ossimAnnotationLineObject.cpp.

References computeBoundingRect().

    :ossimAnnotationObject(r, g, b, thickness),
     theStart(x1, y1),
     theEnd(x2, y2)
 {
    computeBoundingRect();
 }

◆ ossimAnnotationLineObject() [4/4]

ossimAnnotationLineObject::ossimAnnotationLineObject ( const ossimAnnotationLineObject & rhs )

Definition at line 56 of file ossimAnnotationLineObject.cpp.

       :ossimAnnotationObject(rhs),
        theStart(rhs.theStart),
        theEnd(rhs.theEnd),
        theBoundingRect(rhs.theBoundingRect)
 {
 }

Member Function Documentation

◆ applyScale()

void ossimAnnotationLineObject::applyScale	(	double	x,
		double	y
	)

virtual

Implements ossimAnnotationObject.

Definition at line 69 of file ossimAnnotationLineObject.cpp.

References computeBoundingRect(), theEnd, theStart, ossimIpt::x, x, ossimIpt::y, and y.

Referenced by ossimGeoAnnotationLineObject::applyScale().

 {
    theStart.x = ossim::round<int>(theStart.x*x);
    theStart.y = ossim::round<int>(theStart.y*y);
    theEnd.x   = ossim::round<int>(theEnd.x*x);
    theEnd.y   = ossim::round<int>(theEnd.y*y);
    computeBoundingRect();
 }

◆ computeBoundingRect()

void ossimAnnotationLineObject::computeBoundingRect ( )

virtual

Implements ossimAnnotationObject.

Definition at line 150 of file ossimAnnotationLineObject.cpp.

References theBoundingRect, theEnd, and theStart.

Referenced by applyScale(), ossimGeoAnnotationLineObject::computeBoundingRect(), ossimAnnotationLineObject(), and setLine().

 {
    vector<ossimDpt> pts(2);
       
    pts[0] = theStart;
    pts[1] = theEnd;
 
    theBoundingRect = ossimDrect(pts);
 }

◆ draw()

void ossimAnnotationLineObject::draw ( ossimRgbImage & anImage ) const

virtual

Implements ossimAnnotationObject.

Definition at line 101 of file ossimAnnotationLineObject.cpp.

References ossimRgbImage::drawLine(), ossimRgbImage::getImageData(), ossimImageData::getImageRectangle(), ossimDrect::lr(), ossimRgbImage::setDrawColor(), ossimRgbImage::setThickness(), ossimAnnotationObject::theBlue, theEnd, ossimAnnotationObject::theGreen, ossimAnnotationObject::theRed, theStart, ossimAnnotationObject::theThickness, ossimDrect::ul(), ossimRefPtr< T >::valid(), ossimDpt::x, and ossimDpt::y.

Referenced by ossimGeographicAnnotationGrid::draw(), and ossimGeoAnnotationLineObject::draw().

 {
    if(anImage.getImageData().valid())
    {
       anImage.setDrawColor(theRed, theGreen, theBlue);
       anImage.setThickness(theThickness);
       ossimDrect imageRect = anImage.getImageData()->getImageRectangle();
       ossimDpt start = theStart;
       ossimDpt end   = theEnd;
       
       if(anImage.getImageData().valid())
       {
          // we need to extend it by a couple of pixels since
          // if a pixel lies on the edge and then another pixel is just off
          // the edge we will get a stair step and so for several pixels
          // the line might be inside the image rectangle but the clip
          // algorithm will only draw 1 pixel since it thinks the first
          // point is inside and the second point is outside and will
          // execute the clip algorithm keeping only the first
          // point.
          ossimDrect clipRect(imageRect.ul().x - 10,
                              imageRect.ul().y - 10,
                              imageRect.lr().x + 10,
                              imageRect.lr().y + 10);
          // now we can draw.
          if(clipRect.clip(start, end))
          {
             anImage.drawLine(ossimIpt((int)start.x,
                                       (int)start.y),
                              ossimIpt((int)end.x,
                                       (int)end.y));
          }
       }
    }
 }

◆ dup()

ossimObject * ossimAnnotationLineObject::dup ( ) const

virtual

Reimplemented from ossimObject.

Definition at line 64 of file ossimAnnotationLineObject.cpp.

References ossimAnnotationLineObject().

Referenced by getNewClippedObject().

 {
    return new ossimAnnotationLineObject(*this);
 }

◆ getBoundingRect()

void ossimAnnotationLineObject::getBoundingRect ( ossimDrect & rect ) const

virtual

Implements ossimAnnotationObject.

Definition at line 145 of file ossimAnnotationLineObject.cpp.

References theBoundingRect.

Referenced by ossimGeoAnnotationLineObject::getBoundingRect().

 {
    rect = theBoundingRect;
 }

◆ getLine()

void ossimAnnotationLineObject::getLine	(	ossimDpt &	start,
		ossimDpt &	end
	)

Definition at line 167 of file ossimAnnotationLineObject.cpp.

References theEnd, and theStart.

 {
    start = theStart;
    end   = theEnd;
 }

◆ getNewClippedObject()

ossimAnnotationObject * ossimAnnotationLineObject::getNewClippedObject ( const ossimDrect & rect ) const

virtual

Will allocate a new object that is clipped to the passed. in rect. Look at derived classes to see if the object is actually clipped or not. A new object is returned if it clips to the rect else NULL should be returned it doesn't clip.

Implements ossimAnnotationObject.

Definition at line 78 of file ossimAnnotationLineObject.cpp.

References ossimDrect::clip(), dup(), setLine(), theEnd, and theStart.

Referenced by ossimGeoAnnotationLineObject::getNewClippedObject().

 {
    ossimAnnotationLineObject* result = (ossimAnnotationLineObject*)NULL;
    ossimDpt start = theStart;
    ossimDpt end   = theEnd;
    
    if(rect.clip(start, end))
    {
       result = (ossimAnnotationLineObject*)dup();
       result->setLine(start, end);
    }
    
    return result;
 }

◆ intersects()

bool ossimAnnotationLineObject::intersects ( const ossimDrect & rect ) const

virtual

Implements ossimAnnotationObject.

Definition at line 93 of file ossimAnnotationLineObject.cpp.

References ossimDrect::clip(), theEnd, and theStart.

Referenced by ossimGeoAnnotationLineObject::intersects().

 {
    ossimDpt start = theStart;
    ossimDpt end   = theEnd;
    
    return rect.clip(start, end);
 }

◆ isPointWithin()

bool ossimAnnotationLineObject::isPointWithin ( const ossimDpt & imagePoint ) const

virtual

This method allows you to pick an object. It will return true or false if the point falls somewhere on an object. Look at derived classes for further information.

Reimplemented from ossimAnnotationObject.

Definition at line 173 of file ossimAnnotationLineObject.cpp.

References ossimDrect::pointWithin(), and theBoundingRect.

 {
   if(theBoundingRect.pointWithin(point))
   {
     // we will use the implicit form of a line to determine if the point is
     // on the line.  For now we will just return true if it is within the 
     // bounding rect.
     return true;
   }
 
   return false;
 }

◆ print()

std::ostream & ossimAnnotationLineObject::print ( std::ostream & out ) const

virtual

Generic print method.

Derived classes should re-implement as they see fit.

Returns: std::ostream&

Reimplemented from ossimAnnotationObject.

Definition at line 137 of file ossimAnnotationLineObject.cpp.

References theBoundingRect, theEnd, and theStart.

 {
    out << "line_start:    " << theStart << endl
        << "line_end:      " << theEnd   << endl
        << "bounding_rect: " << theBoundingRect << endl;
    return out;
 }

◆ setLine()

void ossimAnnotationLineObject::setLine	(	const ossimDpt &	start,
		const ossimDpt &	end
	)

Definition at line 160 of file ossimAnnotationLineObject.cpp.

References computeBoundingRect(), theEnd, and theStart.

Referenced by ossimChipperUtil::addCrossHairAnnotation(), ossimGeographicAnnotationGrid::draw(), getNewClippedObject(), and ossimGeoAnnotationLineObject::transform().

 {
    theStart = start;
    theEnd   = end;
    computeBoundingRect();
 }

Member Data Documentation

◆ theBoundingRect

ossimDrect ossimAnnotationLineObject::theBoundingRect

protected

Definition at line 57 of file ossimAnnotationLineObject.h.

Referenced by computeBoundingRect(), getBoundingRect(), isPointWithin(), and print().

◆ theEnd

ossimIpt ossimAnnotationLineObject::theEnd

protected

Definition at line 56 of file ossimAnnotationLineObject.h.

Referenced by applyScale(), computeBoundingRect(), draw(), getLine(), getNewClippedObject(), intersects(), print(), and setLine().

◆ theStart

ossimIpt ossimAnnotationLineObject::theStart

protected

Definition at line 55 of file ossimAnnotationLineObject.h.

Referenced by applyScale(), computeBoundingRect(), draw(), getLine(), getNewClippedObject(), intersects(), print(), and setLine().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimAnnotationLineObject() [1/4]

◆ ossimAnnotationLineObject() [2/4]

◆ ossimAnnotationLineObject() [3/4]

◆ ossimAnnotationLineObject() [4/4]

Member Function Documentation

◆ applyScale()

◆ computeBoundingRect()

◆ draw()

◆ dup()

◆ getBoundingRect()

◆ getLine()

◆ getNewClippedObject()

◆ intersects()

◆ isPointWithin()

◆ print()

◆ setLine()

Member Data Documentation

◆ theBoundingRect

◆ theEnd

◆ theStart