casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
casa::PlotShapeArrow Class Referenceabstract

Specialization of PlotShape for an arrow. More...

#include <PlotShape.h>

Inheritance diagram for casa::PlotShapeArrow:
casa::PlotShape casa::PlotItem

Public Types

enum  Style {
  TRIANGLE,
  V_ARROW,
  NOARROW
}
 Arrow style. More...
 

Public Member Functions

 PlotShapeArrow ()
 Constructor. More...
 
virtual ~PlotShapeArrow ()
 Destructor. More...
 
virtual void setArrowCoordinates (const PlotCoordinate &from, const PlotCoordinate &to)=0
 Sets the arrow coordinates to the given. More...
 
virtual Style arrowStyleFrom () const =0
 Gets the arrow style on the from/to points. More...
 
virtual Style arrowStyleTo () const =0
 
virtual void setArrowStyleFrom (Style style)=0
 Sets the arrow style(s) to the given. More...
 
virtual void setArrowStyleTo (Style style)=0
 
virtual void setArrowStyles (Style from, Style to)
 
virtual double arrowSize () const =0
 Returns the arrow size/length. More...
 
virtual void setArrowSize (double size)=0
 Sets the arrow size/length to the given. More...
 
- Public Member Functions inherited from casa::PlotShape
 PlotShape ()
 Constructor. More...
 
virtual ~PlotShape ()
 Destructor. More...
 
virtual unsigned int drawCount () const
 Implements PlotItem::drawCount(). More...
 
virtual std::vector
< PlotCoordinate > 
coordinates () const =0
 ABSTRACT METHODS //. More...
 
virtual void setCoordinates (const std::vector< PlotCoordinate > &c)=0
 Sets this shape's coordinates to the given. More...
 
virtual bool lineShown () const =0
 Returns true if a line is shown for this shape, false otherwise. More...
 
virtual void setLineShown (bool line=true)=0
 Sets whether a line is shown for this shape or not. More...
 
virtual PlotLinePtr line () const =0
 Returns a copy of the line used for this shape. More...
 
virtual void setLine (const PlotLine &line)=0
 Sets this shape's line to the given. More...
 
virtual bool areaFilled () const =0
 Returns true if this shape has an area fill, false otherwise. More...
 
virtual void setAreaFilled (bool area=true)=0
 Sets whether or not this shape has an area fill. More...
 
virtual PlotAreaFillPtr areaFill () const =0
 Returns a copy of the area fill for this shape. More...
 
virtual void setAreaFill (const PlotAreaFill &fill)=0
 Sets this shape's area fill to the given. More...
 
virtual void setLine (const PlotLinePtr l)
 IMPLEMENTED METHODS //. More...
 
virtual void setLine (const casacore::String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
 
virtual void setAreaFill (const PlotAreaFillPtr f)
 Convenience methods for setting the area fill. More...
 
virtual void setAreaFill (const casacore::String &color, PlotAreaFill::Pattern pattern=PlotAreaFill::FILL)
 
- Public Member Functions inherited from casa::PlotItem
 PlotItem ()
 Constructor. More...
 
virtual ~PlotItem ()
 Destructor. More...
 
virtual PlotCanvascanvas () const =0
 Returns the canvas this item is currently attached to, or NULL for none. More...
 
virtual casacore::String title () const =0
 Returns a human-readable title for identification. More...
 
virtual void setTitle (const casacore::String &newTitle)=0
 Sets this items's title to the given. More...
 
virtual bool isValid () const =0
 Returns true if this item is valid, false otherwise. More...
 
virtual bool isQWidget () const =0
 Returns whether this item can be directly casted to a QWidget or not. More...
 
virtual PlotAxis xAxis () const =0
 Returns the item's axes. More...
 
virtual PlotAxis yAxis () const =0
 
virtual void setXAxis (PlotAxis x)=0
 Sets the item's axes. More...
 
virtual void setYAxis (PlotAxis y)=0
 
virtual void setAxes (PlotAxis x, PlotAxis y)
 Sets both the item's axes at once. More...
 
virtual unsigned int drawSegments (unsigned int segmentThreshold) const
 Returns the number of draw segments for this item, using the given segment threshold. More...
 

Detailed Description

Specialization of PlotShape for an arrow.

An arrow is a line segment connecting two points, with optional arrows at either end. PlotShape's line methods apply both to the line segment and the outline of the arrow; the areaFill methods apply to the arrow if applicable. Getting/setting coordinates MUST be in the order: [from, to].

Definition at line 211 of file PlotShape.h.

Member Enumeration Documentation

Arrow style.

Enumerator
TRIANGLE 
V_ARROW 
NOARROW 

Definition at line 214 of file PlotShape.h.

Constructor & Destructor Documentation

casa::PlotShapeArrow::PlotShapeArrow ( )
inline

Constructor.

Definition at line 222 of file PlotShape.h.

virtual casa::PlotShapeArrow::~PlotShapeArrow ( )
inlinevirtual

Destructor.

Definition at line 225 of file PlotShape.h.

Member Function Documentation

virtual double casa::PlotShapeArrow::arrowSize ( ) const
pure virtual

Returns the arrow size/length.

virtual Style casa::PlotShapeArrow::arrowStyleFrom ( ) const
pure virtual

Gets the arrow style on the from/to points.

virtual Style casa::PlotShapeArrow::arrowStyleTo ( ) const
pure virtual
virtual void casa::PlotShapeArrow::setArrowCoordinates ( const PlotCoordinate &  from,
const PlotCoordinate &  to 
)
pure virtual

Sets the arrow coordinates to the given.

virtual void casa::PlotShapeArrow::setArrowSize ( double  size)
pure virtual

Sets the arrow size/length to the given.

virtual void casa::PlotShapeArrow::setArrowStyleFrom ( Style  style)
pure virtual

Sets the arrow style(s) to the given.

Referenced by setArrowStyles().

virtual void casa::PlotShapeArrow::setArrowStyles ( Style  from,
Style  to 
)
inlinevirtual

Definition at line 241 of file PlotShape.h.

References setArrowStyleFrom(), and setArrowStyleTo().

virtual void casa::PlotShapeArrow::setArrowStyleTo ( Style  style)
pure virtual

Referenced by setArrowStyles().


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