#include <ossimAnnotationEllipseObject.h>

Inheritance diagram for ossimAnnotationEllipseObject:

Public Member Functions
	ossimAnnotationEllipseObject (const ossimDpt &center=ossimDpt(0, 0), const ossimDpt &widthHeight=ossimDpt(1, 1), ossim_float64 azimuthInDegrees=0.0, bool enableFill=false, ossim_uint8 r=255, ossim_uint8 g=255, ossim_uint8 b=255, ossim_uint8 thickness=1)

	ossimAnnotationEllipseObject (const ossimAnnotationEllipseObject &rhs)

virtual ossimObject *	dup () const

virtual void	applyScale (double x, double y)

virtual void	draw (ossimRgbImage &anImage) const

virtual bool	intersects (const ossimDrect &rect) const

virtual ossimAnnotationObject *	getNewClippedObject (const ossimDrect &rect) const

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

virtual void	getBoundingRect (ossimDrect &rect) const

virtual void	computeBoundingRect ()

virtual bool	isPointWithin (const ossimDpt &imagePoint) const

virtual void	setCenterWidthHeight (const ossimDpt &center, const ossimDpt &widthHeight)

virtual void	setAzimuth (ossim_float64 azimuth)
	Sets the azimuth. More...

virtual ossim_float64	getAzimuth () const
	Gets the azimuth. More...

virtual void	setFillFlag (bool enabled)

virtual bool	getFillFlag () const

virtual void	setDrawAxesFlag (bool flag)
	Turns on and off drawing of axes on the ellipse. More...

virtual bool	getDrawAxesFlag () const

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...

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 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 Member Functions
virtual	~ossimAnnotationEllipseObject ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimDpt	theCenter

ossimDpt	theWidthHeight

ossim_float64	theAzimuthInDegrees

bool	theFillEnabled

bool	theDrawAxesFlag

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 ()

Static Protected Attributes inherited from ossimAnnotationObject
static ossim_uint32	theIdCounter = 0

Detailed Description

Definition at line 14 of file ossimAnnotationEllipseObject.h.

Constructor & Destructor Documentation

◆ ossimAnnotationEllipseObject() [1/2]

ossimAnnotationEllipseObject::ossimAnnotationEllipseObject	(	const ossimDpt &	center = `ossimDpt(0, 0)`,
		const ossimDpt &	widthHeight = `ossimDpt(1, 1)`,
		ossim_float64	azimuthInDegrees = `0.0`,
		bool	enableFill = `false`,
		ossim_uint8	r = `255`,
		ossim_uint8	g = `255`,
		ossim_uint8	b = `255`,
		ossim_uint8	thickness = `1`
	)

Referenced by dup().

◆ ossimAnnotationEllipseObject() [2/2]

ossimAnnotationEllipseObject::ossimAnnotationEllipseObject ( const ossimAnnotationEllipseObject & rhs )

Definition at line 37 of file ossimAnnotationEllipseObject.cpp.

    :ossimAnnotationObject(rhs),
    theCenter(rhs.theCenter),
    theWidthHeight(rhs.theWidthHeight),
    theAzimuthInDegrees(rhs.theAzimuthInDegrees),
    theFillEnabled(rhs.theFillEnabled),
    theDrawAxesFlag(rhs.theDrawAxesFlag),
    theBoundingRect(rhs.theBoundingRect)
 {
 }

◆ ~ossimAnnotationEllipseObject()

ossimAnnotationEllipseObject::~ossimAnnotationEllipseObject ( )

protectedvirtual

Definition at line 54 of file ossimAnnotationEllipseObject.cpp.

55 {

56 }

Member Function Documentation

◆ applyScale()

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

virtual

Implements ossimAnnotationObject.

Definition at line 58 of file ossimAnnotationEllipseObject.cpp.

References computeBoundingRect(), theCenter, theWidthHeight, ossimDpt::x, x, ossimDpt::y, and y.

Referenced by ossimGeoAnnotationEllipseObject::applyScale().

 {
    theCenter.x      *= x;
    theCenter.y      *= y;
    theWidthHeight.x *= x;
    theWidthHeight.y *= y;
    computeBoundingRect();
 }

◆ computeBoundingRect()

void ossimAnnotationEllipseObject::computeBoundingRect ( )

virtual

Implements ossimAnnotationObject.

Definition at line 130 of file ossimAnnotationEllipseObject.cpp.

References ossim::max(), theBoundingRect, theCenter, theWidthHeight, ossimDpt::x, and ossimDpt::y.

Referenced by applyScale(), ossimGeoAnnotationEllipseObject::computeBoundingRect(), and setCenterWidthHeight().

 {
    ossim_float64 maxDimension =
       ossim::max(theWidthHeight.x, theWidthHeight.y)/2.0 + 1.0;
    theBoundingRect = ossimDrect(theCenter.x - maxDimension,
                                 theCenter.y - maxDimension,
                                 theCenter.x + maxDimension,
                                 theCenter.y + maxDimension);
 }

◆ draw()

void ossimAnnotationEllipseObject::draw ( ossimRgbImage & anImage ) const

virtual

Implements ossimAnnotationObject.

Definition at line 69 of file ossimAnnotationEllipseObject.cpp.

References ossimRgbImage::drawEllipse(), ossimRgbImage::drawFilledEllipse(), ossimRgbImage::getImageData(), ossimImageData::getImageRectangle(), ossimDrect::intersects(), RAD_PER_DEG, ossimRgbImage::setDrawColor(), ossimRgbImage::setThickness(), theAzimuthInDegrees, ossimAnnotationObject::theBlue, theBoundingRect, theCenter, theDrawAxesFlag, theFillEnabled, ossimAnnotationObject::theGreen, ossimAnnotationObject::theRed, ossimAnnotationObject::theThickness, theWidthHeight, ossimDpt::x, and ossimDpt::y.

Referenced by ossimGeoAnnotationEllipseObject::draw().

 {
    anImage.setDrawColor(theRed, theGreen, theBlue);
    anImage.setThickness(theThickness);
 
    if(theBoundingRect.intersects(anImage.getImageData()->getImageRectangle()))
    {
       if(theFillEnabled)
       {
          anImage.drawFilledEllipse((int)(theCenter.x),
                                    (int)(theCenter.y),
                                    (int)(theWidthHeight.x),
                                    (int)(theWidthHeight.y),
                                    theAzimuthInDegrees*RAD_PER_DEG);
       }
       else
       {
          anImage.drawEllipse((int)(theCenter.x),
                              (int)(theCenter.y),
                              (int)(theWidthHeight.x),
                              (int)(theWidthHeight.y),
                              theAzimuthInDegrees*RAD_PER_DEG,
                              theDrawAxesFlag); 
       }
    }
 }

◆ dup()

ossimObject * ossimAnnotationEllipseObject::dup ( ) const

virtual

Reimplemented from ossimObject.

Definition at line 49 of file ossimAnnotationEllipseObject.cpp.

References ossimAnnotationEllipseObject().

Referenced by getNewClippedObject().

 {
    return new ossimAnnotationEllipseObject(*this);
 }

◆ getAzimuth()

ossim_float64 ossimAnnotationEllipseObject::getAzimuth ( ) const

virtual

Gets the azimuth.

Returns: The azimuth in decimal degrees.

Definition at line 159 of file ossimAnnotationEllipseObject.cpp.

References theAzimuthInDegrees.

Referenced by ossimGeoAnnotationEllipseObject::getAzimuth().

 {
    return theAzimuthInDegrees;
 }

◆ getBoundingRect()

void ossimAnnotationEllipseObject::getBoundingRect ( ossimDrect & rect ) const

virtual

Implements ossimAnnotationObject.

Definition at line 125 of file ossimAnnotationEllipseObject.cpp.

References theBoundingRect.

Referenced by ossimGeoAnnotationEllipseObject::getBoundingRect().

 {
    rect = theBoundingRect;
 }

◆ getDrawAxesFlag()

bool ossimAnnotationEllipseObject::getDrawAxesFlag ( ) const

virtual

Returns: The draw axes flag.

Definition at line 179 of file ossimAnnotationEllipseObject.cpp.

References theDrawAxesFlag.

Referenced by ossimGeoAnnotationEllipseObject::getDrawAxesFlag().

 {
    return theDrawAxesFlag;
 }

◆ getFillFlag()

bool ossimAnnotationEllipseObject::getFillFlag ( ) const

virtual

Returns: theFillEnabled flag.

Definition at line 169 of file ossimAnnotationEllipseObject.cpp.

References theFillEnabled.

Referenced by ossimGeoAnnotationEllipseObject::getFillFlag().

 {
    return theFillEnabled;
 }

◆ getNewClippedObject()

ossimAnnotationObject * ossimAnnotationEllipseObject::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 101 of file ossimAnnotationEllipseObject.cpp.

References dup(), and intersects().

Referenced by ossimGeoAnnotationEllipseObject::getNewClippedObject().

 {
    if(intersects(rect))
    {
       return (ossimAnnotationObject*)dup();
    }
    
    return (ossimAnnotationEllipseObject*)NULL;
 }

◆ intersects()

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

virtual

Implements ossimAnnotationObject.

Definition at line 96 of file ossimAnnotationEllipseObject.cpp.

References ossimDrect::intersects(), and theBoundingRect.

Referenced by getNewClippedObject(), and ossimGeoAnnotationEllipseObject::intersects().

 {
    return rect.intersects(theBoundingRect);
 }

◆ isPointWithin()

bool ossimAnnotationEllipseObject::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 140 of file ossimAnnotationEllipseObject.cpp.

References ossimDrect::pointWithin(), and theBoundingRect.

 {
   return theBoundingRect.pointWithin(point);
 }

◆ loadState()

bool ossimAnnotationEllipseObject::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)

virtual

Method to the load (recreate) the state of an object from a keyword list.

Return true if ok or false on error.

Reimplemented from ossimAnnotationObject.

Definition at line 190 of file ossimAnnotationEllipseObject.cpp.

References ossimAnnotationObject::loadState().

 {
    return ossimAnnotationObject::loadState(kwl, prefix);
 }

◆ print()

std::ostream & ossimAnnotationEllipseObject::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 112 of file ossimAnnotationEllipseObject.cpp.

References ossimAnnotationObject::print(), theBoundingRect, theCenter, theDrawAxesFlag, theFillEnabled, theWidthHeight, ossimDpt::x, and ossimDpt::y.

 {
    ossimAnnotationObject::print(out);
    out << endl;
    out << "ellipse_center:        " << theCenter
        << "\nellipse_height:        " << theWidthHeight.y
        << "\nellipse_width:         " << theWidthHeight.x
        << "\nfill_enabled:          " << theFillEnabled
        << "\ndraw_axes:             " << theDrawAxesFlag
        << "\nellipse_bounding_rect: " << theBoundingRect;
    return out;
 }

◆ saveState()

bool ossimAnnotationEllipseObject::saveState	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Saves the current state of this object.

Reimplemented from ossimAnnotationObject.

Definition at line 184 of file ossimAnnotationEllipseObject.cpp.

References ossimAnnotationObject::saveState().

 {
    return ossimAnnotationObject::saveState(kwl, prefix);
 }

◆ setAzimuth()

void ossimAnnotationEllipseObject::setAzimuth ( ossim_float64 azimuth )

virtual

Sets the azimuth.

Parameters

azimuth in degrees.

Definition at line 154 of file ossimAnnotationEllipseObject.cpp.

References theAzimuthInDegrees.

Referenced by ossimGeoAnnotationEllipseObject::setAzimuth().

 {
    theAzimuthInDegrees = azimuth;
 }

◆ setCenterWidthHeight()

void ossimAnnotationEllipseObject::setCenterWidthHeight	(	const ossimDpt &	center,
		const ossimDpt &	widthHeight
	)

virtual

Definition at line 145 of file ossimAnnotationEllipseObject.cpp.

References computeBoundingRect(), theCenter, and theWidthHeight.

Referenced by ossimGeoAnnotationEllipseObject::transform().

 {
    theCenter          = center;
    theWidthHeight     = widthHeight;
 
    computeBoundingRect();
 }

◆ setDrawAxesFlag()

void ossimAnnotationEllipseObject::setDrawAxesFlag ( bool flag )

virtual

Turns on and off drawing of axes on the ellipse.

This flag is only used if fill is turned off.

Parameters

flag	true to enable, false to disable.

Definition at line 174 of file ossimAnnotationEllipseObject.cpp.

References theDrawAxesFlag.

Referenced by ossimGeoAnnotationEllipseObject::setDrawAxesFlag().

 {
    theDrawAxesFlag = flag;
 }

◆ setFillFlag()

void ossimAnnotationEllipseObject::setFillFlag ( bool enabled )

virtual

Definition at line 164 of file ossimAnnotationEllipseObject.cpp.

References theFillEnabled.

Referenced by ossimGeoAnnotationEllipseObject::setFillFlag().

 {
    theFillEnabled = enabled;
 }

Member Data Documentation

◆ theAzimuthInDegrees

ossim_float64 ossimAnnotationEllipseObject::theAzimuthInDegrees

protected

Definition at line 93 of file ossimAnnotationEllipseObject.h.

Referenced by draw(), getAzimuth(), and setAzimuth().

◆ theBoundingRect

ossimDrect ossimAnnotationEllipseObject::theBoundingRect

protected

Definition at line 96 of file ossimAnnotationEllipseObject.h.

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

◆ theCenter

ossimDpt ossimAnnotationEllipseObject::theCenter

protected

Definition at line 91 of file ossimAnnotationEllipseObject.h.

Referenced by applyScale(), computeBoundingRect(), draw(), print(), and setCenterWidthHeight().

◆ theDrawAxesFlag

bool ossimAnnotationEllipseObject::theDrawAxesFlag

protected

Definition at line 95 of file ossimAnnotationEllipseObject.h.

Referenced by draw(), getDrawAxesFlag(), print(), and setDrawAxesFlag().

◆ theFillEnabled

bool ossimAnnotationEllipseObject::theFillEnabled

protected

Definition at line 94 of file ossimAnnotationEllipseObject.h.

Referenced by draw(), getFillFlag(), print(), and setFillFlag().

◆ theWidthHeight

ossimDpt ossimAnnotationEllipseObject::theWidthHeight

protected

Definition at line 92 of file ossimAnnotationEllipseObject.h.

Referenced by applyScale(), computeBoundingRect(), draw(), print(), and setCenterWidthHeight().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimAnnotationEllipseObject() [1/2]

◆ ossimAnnotationEllipseObject() [2/2]

◆ ~ossimAnnotationEllipseObject()

Member Function Documentation

◆ applyScale()

◆ computeBoundingRect()

◆ draw()

◆ dup()

◆ getAzimuth()

◆ getBoundingRect()

◆ getDrawAxesFlag()

◆ getFillFlag()

◆ getNewClippedObject()

◆ intersects()

◆ isPointWithin()

◆ loadState()

◆ print()

◆ saveState()

◆ setAzimuth()

◆ setCenterWidthHeight()

◆ setDrawAxesFlag()

◆ setFillFlag()

Member Data Documentation

◆ theAzimuthInDegrees

◆ theBoundingRect

◆ theCenter

◆ theDrawAxesFlag

◆ theFillEnabled

◆ theWidthHeight