viskores::rendering::AxisAnnotation2D Class Reference

#include <AxisAnnotation2D.h>

Inheritance diagram for viskores::rendering::AxisAnnotation2D:

Public Member Functions
	AxisAnnotation2D ()
	AxisAnnotation2D (const AxisAnnotation2D &)=delete
AxisAnnotation2D &	operator= (const AxisAnnotation2D &)=delete
void	SetLogarithmic (bool l)
void	SetMoreOrLessTickAdjustment (int offset)
void	SetColor (viskores::rendering::Color c)
void	SetLineWidth (viskores::Float32 lw)
void	SetMajorTickSize (viskores::Float64 xlen, viskores::Float64 ylen, viskores::Float64 offset)
void	SetMinorTickSize (viskores::Float64 xlen, viskores::Float64 ylen, viskores::Float64 offset)
void	SetScreenPosition (viskores::Float64 x0, viskores::Float64 y0, viskores::Float64 x1, viskores::Float64 y1)
void	SetLabelAlignment (TextAnnotation::HorizontalAlignment h, TextAnnotation::VerticalAlignment v)
void	SetLabelFontScale (viskores::Float32 s)
void	SetRangeForAutoTicks (const viskores::Range &range)
void	SetRangeForAutoTicks (viskores::Float64 lower, viskores::Float64 upper)
void	SetMajorTicks (const std::vector< viskores::Float64 > &positions, const std::vector< viskores::Float64 > &proportions)
void	SetMinorTicks (const std::vector< viskores::Float64 > &positions, const std::vector< viskores::Float64 > &proportions)
void	Render (const viskores::rendering::Camera &camera, const viskores::rendering::WorldAnnotator &worldAnnotator, viskores::rendering::Canvas &canvas) override
Public Member Functions inherited from viskores::rendering::AxisAnnotation
	AxisAnnotation ()=default
virtual	~AxisAnnotation ()=default

Protected Attributes
viskores::Float64	MajorTickSizeX
viskores::Float64	MajorTickSizeY
viskores::Float64	MajorTickOffset
viskores::Float64	MinorTickSizeX
viskores::Float64	MinorTickSizeY
viskores::Float64	MinorTickOffset
viskores::Float64	PosX0
viskores::Float64	PosY0
viskores::Float64	PosX1
viskores::Float64	PosY1
viskores::Range	TickRange
viskores::Float32	FontScale
viskores::Float32	LineWidth
viskores::rendering::Color	Color
bool	Logarithmic
TextAnnotation::HorizontalAlignment	AlignH
TextAnnotation::VerticalAlignment	AlignV
std::vector< std::unique_ptr< TextAnnotation > >	Labels
std::vector< viskores::Float64 >	PositionsMajor
std::vector< viskores::Float64 >	ProportionsMajor
std::vector< viskores::Float64 >	PositionsMinor
std::vector< viskores::Float64 >	ProportionsMinor
int	MoreOrLessTickAdjustment

Additional Inherited Members
Static Protected Member Functions inherited from viskores::rendering::AxisAnnotation
static void	CalculateTicks (const viskores::Range &range, bool minor, std::vector< viskores::Float64 > &positions, std::vector< viskores::Float64 > &proportions, int modifyTickQuantity)
static void	CalculateTicksLogarithmic (const viskores::Range &range, bool minor, std::vector< viskores::Float64 > &positions, std::vector< viskores::Float64 > &proportions)

Constructor & Destructor Documentation

AxisAnnotation2D() [1/2]

viskores::rendering::AxisAnnotation2D::AxisAnnotation2D

(

)

AxisAnnotation2D() [2/2]

viskores::rendering::AxisAnnotation2D::AxisAnnotation2D ( const AxisAnnotation2D &  )

delete

Member Function Documentation

operator=()

AxisAnnotation2D& viskores::rendering::AxisAnnotation2D::operator= ( const AxisAnnotation2D &  )

delete

Render()

void viskores::rendering::AxisAnnotation2D::Render ( const viskores::rendering::Camera &  camera, const viskores::rendering::WorldAnnotator &  worldAnnotator, viskores::rendering::Canvas &  canvas  )

overridevirtual

Implements viskores::rendering::AxisAnnotation.

SetColor()

void viskores::rendering::AxisAnnotation2D::SetColor ( viskores::rendering::Color  c )

inline

SetLabelAlignment()

void viskores::rendering::AxisAnnotation2D::SetLabelAlignment ( TextAnnotation::HorizontalAlignment  h, TextAnnotation::VerticalAlignment  v  )

inline

SetLabelFontScale()

void viskores::rendering::AxisAnnotation2D::SetLabelFontScale ( viskores::Float32  s )

inline

SetLineWidth()

void viskores::rendering::AxisAnnotation2D::SetLineWidth ( viskores::Float32  lw )

inline

SetLogarithmic()

void viskores::rendering::AxisAnnotation2D::SetLogarithmic ( bool  l )

inline

SetMajorTicks()

void viskores::rendering::AxisAnnotation2D::SetMajorTicks	(	const std::vector< viskores::Float64 > &	positions,
		const std::vector< viskores::Float64 > &	proportions
	)

SetMajorTickSize()

void viskores::rendering::AxisAnnotation2D::SetMajorTickSize ( viskores::Float64  xlen, viskores::Float64  ylen, viskores::Float64  offset  )

inline

offset of 0 means the tick is inside the frame offset of 1 means the tick is outside the frame offset of 0.5 means the tick is centered on the frame

SetMinorTicks()

void viskores::rendering::AxisAnnotation2D::SetMinorTicks	(	const std::vector< viskores::Float64 > &	positions,
		const std::vector< viskores::Float64 > &	proportions
	)

SetMinorTickSize()

void viskores::rendering::AxisAnnotation2D::SetMinorTickSize ( viskores::Float64  xlen, viskores::Float64  ylen, viskores::Float64  offset  )

inline

SetMoreOrLessTickAdjustment()

void viskores::rendering::AxisAnnotation2D::SetMoreOrLessTickAdjustment ( int  offset )

inline

SetRangeForAutoTicks() [1/2]

void viskores::rendering::AxisAnnotation2D::SetRangeForAutoTicks

(

const viskores::Range &

range

)

SetRangeForAutoTicks() [2/2]

void viskores::rendering::AxisAnnotation2D::SetRangeForAutoTicks ( viskores::Float64  lower, viskores::Float64  upper  )

inline

SetScreenPosition()

void viskores::rendering::AxisAnnotation2D::SetScreenPosition ( viskores::Float64  x0, viskores::Float64  y0, viskores::Float64  x1, viskores::Float64  y1  )

inline

Todo:

: rename, since it might be screen OR world position?

Member Data Documentation

AlignH

TextAnnotation::HorizontalAlignment viskores::rendering::AxisAnnotation2D::AlignH

protected

AlignV

TextAnnotation::VerticalAlignment viskores::rendering::AxisAnnotation2D::AlignV

protected

Color

viskores::rendering::Color viskores::rendering::AxisAnnotation2D::Color

protected

FontScale

viskores::Float32 viskores::rendering::AxisAnnotation2D::FontScale

protected

Labels

std::vector<std::unique_ptr<TextAnnotation> > viskores::rendering::AxisAnnotation2D::Labels

protected

LineWidth

viskores::Float32 viskores::rendering::AxisAnnotation2D::LineWidth

protected

Logarithmic

bool viskores::rendering::AxisAnnotation2D::Logarithmic

protected

MajorTickOffset

viskores::Float64 viskores::rendering::AxisAnnotation2D::MajorTickOffset

protected

MajorTickSizeX

viskores::Float64 viskores::rendering::AxisAnnotation2D::MajorTickSizeX

protected

MajorTickSizeY

viskores::Float64 viskores::rendering::AxisAnnotation2D::MajorTickSizeY

protected

MinorTickOffset

viskores::Float64 viskores::rendering::AxisAnnotation2D::MinorTickOffset

protected

MinorTickSizeX

viskores::Float64 viskores::rendering::AxisAnnotation2D::MinorTickSizeX

protected

MinorTickSizeY

viskores::Float64 viskores::rendering::AxisAnnotation2D::MinorTickSizeY

protected

MoreOrLessTickAdjustment

int viskores::rendering::AxisAnnotation2D::MoreOrLessTickAdjustment

protected

PositionsMajor

std::vector<viskores::Float64> viskores::rendering::AxisAnnotation2D::PositionsMajor

protected

PositionsMinor

std::vector<viskores::Float64> viskores::rendering::AxisAnnotation2D::PositionsMinor

protected

PosX0

viskores::Float64 viskores::rendering::AxisAnnotation2D::PosX0

protected

PosX1

viskores::Float64 viskores::rendering::AxisAnnotation2D::PosX1

protected

PosY0

viskores::Float64 viskores::rendering::AxisAnnotation2D::PosY0

protected

PosY1

viskores::Float64 viskores::rendering::AxisAnnotation2D::PosY1

protected

ProportionsMajor

std::vector<viskores::Float64> viskores::rendering::AxisAnnotation2D::ProportionsMajor

protected

ProportionsMinor

std::vector<viskores::Float64> viskores::rendering::AxisAnnotation2D::ProportionsMinor

protected

TickRange

viskores::Range viskores::rendering::AxisAnnotation2D::TickRange

protected

---

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

• AxisAnnotation2D.h