#include <ossimAnnotationObject.h>

Inheritance diagram for ossimAnnotationObject:

Public Member Functions
virtual	~ossimAnnotationObject ()

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

virtual void	applyScale (double x, double y)=0

virtual void	applyScale (const ossimDpt &scale)

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

virtual void	draw (ossimRgbImage &anImage) const =0

virtual bool	intersects (const ossimDrect &rect) const =0

virtual ossimAnnotationObject *	getNewClippedObject (const ossimDrect &rect) const =0

virtual void	getBoundingRect (ossimDrect &rect) const =0

virtual ossimDrect	getBoundingRect () const

virtual void	computeBoundingRect ()=0

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	isPointWithin (const ossimDpt &imagePoint) 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...

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 ossimObject *	dup () const

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

Static Public Member Functions
static ossim_uint32	getNextId ()

static void	restIdCounter ()

Protected Attributes
ossim_uint8	theRed

ossim_uint8	theGreen

ossim_uint8	theBlue

ossim_uint8	theThickness

ossimString	theName

ossim_uint32	theId

Static Protected Attributes
static ossim_uint32	theIdCounter = 0

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 21 of file ossimAnnotationObject.h.

Constructor & Destructor Documentation

◆ ~ossimAnnotationObject()

ossimAnnotationObject::~ossimAnnotationObject ( )

virtual

Definition at line 16 of file ossimAnnotationObject.cpp.

17 {}

◆ ossimAnnotationObject()

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

Definition at line 31 of file ossimAnnotationObject.cpp.

References getNextId(), and theId.

    :theRed(r),
     theGreen(g),
     theBlue(b),
     theThickness(thickness)
 {
   theId = getNextId();
 }

Member Function Documentation

◆ applyScale() [1/2]

virtual void ossimAnnotationObject::applyScale	(	double	x,
		double	y
	)

pure virtual

◆ applyScale() [2/2]

void ossimAnnotationObject::applyScale ( const ossimDpt & scale )

virtual

Definition at line 143 of file ossimAnnotationObject.cpp.

References applyScale(), ossimDpt::x, and ossimDpt::y.

 {
    applyScale(scale.x,
               scale.y);
 }

◆ computeBoundingRect()

virtual void ossimAnnotationObject::computeBoundingRect ( )

pure virtual

◆ draw()

virtual void ossimAnnotationObject::draw ( ossimRgbImage & anImage ) const

pure virtual

◆ getBoundingRect() [1/2]

virtual void ossimAnnotationObject::getBoundingRect ( ossimDrect & rect ) const

pure virtual

◆ getBoundingRect() [2/2]

ossimDrect ossimAnnotationObject::getBoundingRect ( ) const

virtual

Definition at line 136 of file ossimAnnotationObject.cpp.

 {
    ossimDrect rect;
    getBoundingRect(rect);
    return rect;
 }

◆ getColor()

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

Definition at line 57 of file ossimAnnotationObject.cpp.

References theBlue, theGreen, and theRed.

 {
    r = theRed;
    g = theGreen;
    b = theBlue;
 }

◆ getId()

ossim_uint32 ossimAnnotationObject::getId ( ) const

Definition at line 71 of file ossimAnnotationObject.cpp.

References theId.

Referenced by setId().

 {
   return theId;
 }

◆ getName()

ossimString ossimAnnotationObject::getName ( ) const

virtual

Definition at line 126 of file ossimAnnotationObject.cpp.

References theName.

 {
    return theName;
 }

◆ getNewClippedObject()

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

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

◆ getNextId()

ossim_uint32 ossimAnnotationObject::getNextId ( )

static

Definition at line 24 of file ossimAnnotationObject.cpp.

References theIdCounter.

Referenced by ossimAnnotationObject(), and setId().

 {
   ossim_uint32 id = theIdCounter;
   ++theIdCounter;
   return id;
 }

◆ getThickness()

ossim_uint8 ossimAnnotationObject::getThickness ( ) const

Definition at line 66 of file ossimAnnotationObject.cpp.

References theThickness.

 {
    return theThickness;
 }

◆ intersects()

virtual bool ossimAnnotationObject::intersects ( const ossimDrect & rect ) const

pure virtual

◆ isPointWithin()

bool ossimAnnotationObject::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 in ossimAnnotationGdBitmapFont, ossimAnnotationMultiPolyObject, ossimAnnotationMultiLineObject, ossimAnnotationPolyObject, ossimAnnotationFontObject, ossimGeoAnnotationMultiPolyLineObject, ossimGeoAnnotationMultiPolyObject, ossimAnnotationLineObject, ossimAnnotationMultiEllipseObject, ossimAnnotationEllipseObject, and ossimAnnotationMultiPolyLineObject.

Definition at line 121 of file ossimAnnotationObject.cpp.

Referenced by ossimAnnotationSource::pickObjects().

 {
    return false;
 }

◆ loadState()

bool ossimAnnotationObject::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 ossimObject.

Reimplemented in ossimGeoAnnotationFontObject, ossimAnnotationEllipseObject, ossimGeoAnnotationPolyObject, ossimGeoAnnotationMultiPolyLineObject, ossimGeoAnnotationEllipseObject, and ossimGeoAnnotationObject.

Definition at line 93 of file ossimAnnotationObject.cpp.

References ossimKeywordlist::find(), ossimObject::loadState(), theBlue, theGreen, theRed, theThickness, and ossimString::toLong().

Referenced by ossimChipperUtil::addCrossHairAnnotation(), ossimAnnotationObjectFactory::create(), ossimGeoAnnotationObject::loadState(), and ossimAnnotationEllipseObject::loadState().

 {
    const char* red       = kwl.find(prefix, "red");
    const char* green     = kwl.find(prefix, "green");
    const char* blue      = kwl.find(prefix, "blue");
    const char* thickness = kwl.find(prefix, "thickness");
 
    if(red)
    {
       theRed = (ossim_uint8)ossimString(red).toLong();
    }
    if(green)
    {
       theGreen = (ossim_uint8)ossimString(green).toLong();
    }
    if(blue)
    {
       theBlue = (ossim_uint8)ossimString(blue).toLong();
    }
    if(thickness)
    {
       theThickness = (ossim_uint8)ossimString(thickness).toLong();
    }
    
    return ossimObject::loadState(kwl, prefix);
 }

◆ print()

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

virtual

Generic print method.

Derived classes should re-implement as they see fit.

Returns: std::ostream&

Reimplemented from ossimObject.

Definition at line 149 of file ossimAnnotationObject.cpp.

References theBlue, theGreen, theRed, and theThickness.

Referenced by ossimAnnotationMultiPolyLineObject::print(), ossimAnnotationEllipseObject::print(), ossimAnnotationMultiPolyObject::print(), and ossimAnnotationMultiLineObject::print().

 {
    out << setw(15)<<setiosflags(ios::left)<<"Red:" << (long)theRed
        << setw(15)<<setiosflags(ios::left)<<"\nGreen:" << (long)theGreen
        << setw(15)<<setiosflags(ios::left)<<"\nBlue:" << (long)theBlue
        << setw(15)<<setiosflags(ios::left)<<"\nThickness:"<< (long)theThickness
        << "\ncolor_red:   " << (long)theRed
        << "\ncolor_green: " << (long)theGreen
        << "\ncolor_blue:  " << (long)theBlue
        << "\nthickness:   " << (long)theThickness << std::endl;
    return out;
 }

◆ restIdCounter()

void ossimAnnotationObject::restIdCounter ( )

static

Definition at line 19 of file ossimAnnotationObject.cpp.

References theIdCounter.

 {
   theIdCounter = 0;
 }

◆ saveState()

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

virtual

Saves the current state of this object.

Reimplemented from ossimObject.

Reimplemented in ossimAnnotationEllipseObject, ossimGeoAnnotationPolyObject, ossimGeoAnnotationFontObject, ossimGeoAnnotationMultiPolyLineObject, ossimGeoAnnotationEllipseObject, and ossimGeoAnnotationObject.

Definition at line 82 of file ossimAnnotationObject.cpp.

References ossimKeywordlist::add(), ossimObject::saveState(), theBlue, theGreen, theRed, and theThickness.

Referenced by ossimGeoAnnotationObject::saveState(), and ossimAnnotationEllipseObject::saveState().

 {
    kwl.add(prefix, "red",       theRed);
    kwl.add(prefix, "green",     theGreen);
    kwl.add(prefix, "blue",      theBlue);
    kwl.add(prefix, "thickness", theThickness);
    
    return ossimObject::saveState(kwl, prefix);
 }

◆ setColor()

void ossimAnnotationObject::setColor	(	ossim_uint8	r,
		ossim_uint8	g,
		ossim_uint8	b
	)

virtual

Reimplemented in ossimGeoAnnotationEllipseObject, ossimGeoAnnotationPolyObject, ossimGeoAnnotationMultiPolyLineObject, ossimGeoAnnotationFontObject, ossimGeoAnnotationMultiEllipseObject, ossimGeoAnnotationPolyLineObject, and ossimGeoAnnotationMultiPolyObject.

Definition at line 43 of file ossimAnnotationObject.cpp.

References theBlue, theGreen, and theRed.

Referenced by ossimMapCompositionSource::addGeographicBottomGridLabels(), ossimMapCompositionSource::addGeographicGridLines(), ossimMapCompositionSource::addGeographicGridReseaux(), ossimMapCompositionSource::addGeographicLeftGridLabels(), ossimMapCompositionSource::addGeographicRightGridLabels(), ossimMapCompositionSource::addMeterGridLabels(), ossimMapCompositionSource::addMeterGridLines(), ossimMapCompositionSource::addMeterGridReseaux(), ossimMapCompositionSource::addTitle(), ossimGeoAnnotationEllipseObject::loadState(), ossimGeoAnnotationPolyObject::loadState(), ossimGeoAnnotationFontObject::loadState(), ossimGeoAnnotationMultiPolyObject::setColor(), ossimGeoAnnotationPolyLineObject::setColor(), ossimGeoAnnotationMultiEllipseObject::setColor(), ossimGeoAnnotationFontObject::setColor(), ossimGeoAnnotationMultiPolyLineObject::setColor(), ossimGeoAnnotationPolyObject::setColor(), and ossimGeoAnnotationEllipseObject::setColor().

 {
    theRed    = r;
    theGreen = g;
    theBlue   = b;
 }

◆ setId()

ossim_uint32 ossimAnnotationObject::setId ( )

virtual

Definition at line 76 of file ossimAnnotationObject.cpp.

References getId(), getNextId(), and theId.

 {
   theId = getNextId();
   return getId();
 }

◆ setName()

void ossimAnnotationObject::setName ( const ossimString & name )

virtual

Definition at line 131 of file ossimAnnotationObject.cpp.

References theName.

Referenced by ossimEsriShapeFileFilter::loadArc(), ossimEsriShapeFileFilter::loadPoint(), and ossimEsriShapeFileFilter::loadPolygon().

 {
    theName = name;
 }

◆ setThickness()

void ossimAnnotationObject::setThickness ( ossim_uint8 thickness )

virtual

Reimplemented in ossimGeoAnnotationEllipseObject, ossimGeoAnnotationPolyObject, ossimGeoAnnotationMultiPolyLineObject, ossimGeoAnnotationPolyLineObject, ossimGeoAnnotationMultiEllipseObject, and ossimGeoAnnotationMultiPolyObject.

Definition at line 52 of file ossimAnnotationObject.cpp.

References theThickness.

Referenced by ossimVpfAnnotationFeatureInfo::buildTxtFeature(), ossimGeoAnnotationEllipseObject::loadState(), ossimGeoAnnotationPolyObject::loadState(), ossimGeoAnnotationFontObject::loadState(), ossimVpfAnnotationFeatureInfo::setDrawingFeaturesToAnnotation(), ossimGeoAnnotationMultiPolyObject::setThickness(), ossimGeoAnnotationMultiEllipseObject::setThickness(), ossimGeoAnnotationPolyLineObject::setThickness(), ossimGeoAnnotationMultiPolyLineObject::setThickness(), ossimGeoAnnotationPolyObject::setThickness(), and ossimGeoAnnotationEllipseObject::setThickness().

 {
    theThickness = thickness;
 }

Member Data Documentation

◆ theBlue

ossim_uint8 ossimAnnotationObject::theBlue

protected

Definition at line 95 of file ossimAnnotationObject.h.

◆ theGreen

ossim_uint8 ossimAnnotationObject::theGreen

protected

Definition at line 94 of file ossimAnnotationObject.h.

◆ theId

ossim_uint32 ossimAnnotationObject::theId

protected

Definition at line 99 of file ossimAnnotationObject.h.

Referenced by getId(), ossimAnnotationObject(), and setId().

◆ theIdCounter

ossim_uint32 ossimAnnotationObject::theIdCounter = 0

staticprotected

Definition at line 101 of file ossimAnnotationObject.h.

Referenced by getNextId(), and restIdCounter().

◆ theName

ossimString ossimAnnotationObject::theName

protected

Definition at line 98 of file ossimAnnotationObject.h.

Referenced by getName(), and setName().

◆ theRed

ossim_uint8 ossimAnnotationObject::theRed

protected

Definition at line 93 of file ossimAnnotationObject.h.

◆ theThickness

ossim_uint8 ossimAnnotationObject::theThickness

protected

Definition at line 96 of file ossimAnnotationObject.h.

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ossimAnnotationObject()

◆ ossimAnnotationObject()

Member Function Documentation

◆ applyScale() [1/2]

◆ applyScale() [2/2]

◆ computeBoundingRect()

◆ draw()

◆ getBoundingRect() [1/2]

◆ getBoundingRect() [2/2]

◆ getColor()

◆ getId()

◆ getName()

◆ getNewClippedObject()

◆ getNextId()

◆ getThickness()

◆ intersects()

◆ isPointWithin()

◆ loadState()

◆ print()

◆ restIdCounter()

◆ saveState()

◆ setColor()

◆ setId()

◆ setName()

◆ setThickness()

Member Data Documentation

◆ theBlue

◆ theGreen

◆ theId

◆ theIdCounter

◆ theName

◆ theRed

◆ theThickness