kalzium

Avogadro::GLPainter

Avogadro::GLPainter Class Reference

#include <glpainter.h>

Inheritance diagram for Avogadro::GLPainter:

[legend]

List of all members.

Detailed Description

Implementation of the Painter class using OpenGL.

Author:: Marcus D. Hanwell

This class implements the base Painter class using OpenGL. It is intended to be used with the GLWidget to render molecules and other constructs to an OpenGL context.

See also:: Painter

Definition at line 49 of file src/glpainter.h.


Public Member Functions
void	begin (GLWidget *widget)
void	drawArc (const Eigen::Vector3d &origin, const Eigen::Vector3d &direction1, const Eigen::Vector3d &direction2, double radius, double lineWidth, bool alternateAngle=false)
void	drawCone (const Eigen::Vector3d &base, const Eigen::Vector3d &tip, double radius)
void	drawCylinder (const Eigen::Vector3d &end1, const Eigen::Vector3d &end2, double radius)
void	drawLine (const Eigen::Vector3d &start, const Eigen::Vector3d &end, double lineWidth)
void	drawMultiCylinder (const Eigen::Vector3d &end1, const Eigen::Vector3d &end2, double radius, int order, double shift)
void	drawMultiLine (const Eigen::Vector3d &start, const Eigen::Vector3d &end, double lineWidth, int order, short stipple)
void	drawQuadrilateral (const Eigen::Vector3d &point1, const Eigen::Vector3d &point2, const Eigen::Vector3d &point3, const Eigen::Vector3d &point4, double lineWidth)
void	drawShadedQuadrilateral (const Eigen::Vector3d &point1, const Eigen::Vector3d &point2, const Eigen::Vector3d &point3, const Eigen::Vector3d &point4)
void	drawShadedSector (const Eigen::Vector3d &origin, const Eigen::Vector3d &direction1, const Eigen::Vector3d &direction2, double radius, bool alternateAngle=false)
void	drawSphere (const Eigen::Vector3d &center, double radius)
void	drawSpline (const QVector< Eigen::Vector3d > &pts, double radius)
int	drawText (const Eigen::Vector3d &pos, const QString &string) const
int	drawText (const QPoint &pos, const QString &string) const
int	drawText (int x, int y, const QString &string) const
void	drawTriangle (const Eigen::Vector3d &p1, const Eigen::Vector3d &p2, const Eigen::Vector3d &p3, const Eigen::Vector3d &n)
void	drawTriangle (const Eigen::Vector3d &p1, const Eigen::Vector3d &p2, const Eigen::Vector3d &p3)
void	end ()
	GLPainter (int quality=-1)
bool	isActive ()
bool	isShared ()
int	quality () const
void	setColor (float red, float green, float blue, float alpha=1.0)
void	setColor (const Color *color)
void	setDynamicScaling (bool scaling)
void	setName (Primitive::Type type, int id)
void	setName (const Primitive *primitive)
void	setQuality (int quality)
	~GLPainter ()
Static Public Member Functions
static int	defaultQuality ()
static int	maxQuality ()

Constructor & Destructor Documentation

Avogadro::GLPainter::GLPainter ( int quality = -1 )

Constructor.

Parameters:

quality

defaults to -1, valid range from 0 to 4.

Definition at line 271 of file glpainter.cpp.

Avogadro::GLPainter::~GLPainter ( )

Destructor.

Definition at line 280 of file glpainter.cpp.

Member Function Documentation

void Avogadro::GLPainter::begin ( GLWidget * widget )

Set the Painter up for painting onto a GLWidget, should be called before any painting.

Definition at line 1091 of file glpainter.cpp.

int Avogadro::GLPainter::defaultQuality ( ) [static]

Returns:: the default quality level of the Painter.

Definition at line 1061 of file glpainter.cpp.

void Avogadro::GLPainter::drawArc	(	const Eigen::Vector3d &	origin,
		const Eigen::Vector3d &	direction1,
		const Eigen::Vector3d &	direction2,
		double	radius,
		double	lineWidth,
		bool	alternateAngle = `false`
	)			`[virtual]`

Draws an arc.

The arc is defined by three vectors, the center of the circle, and two vectors that define the lines going out from the center of the circle to the circumference of the circle. The actual points on the circumference are found using these two vectors and the radius of the circle.

Parameters:

	origin	the center of the circle whose circumference this arc is a portion of.
	direction1	a vector defining the line the start of the arc will lie on.
	direction2	a vector defining the line the end of the arc will lie on.
	radius	the radius of the circle whose circumference this arc is a portion of.
	lineWidth	the thickness of the line the arc will be drawn with.
	alternateAngle	whether to draw the obtuse angle made by the two vectors instead of the acute angle between them.

void Avogadro::GLPainter::drawCone	(	const Eigen::Vector3d &	base,
		const Eigen::Vector3d &	tip,
		double	radius
	)			`[virtual]`

	base	the position of the base of the cone.
	tip	the position of the tip of the cone.
	radius	the radius of the base of the cone.

void Avogadro::GLPainter::drawCylinder	(	const Eigen::Vector3d &	end1,
		const Eigen::Vector3d &	end2,
		double	radius
	)			`[virtual]`

	end1	the position of the first end of the cylinder.
	end2	the position of the second end of the cylinder.
	radius	the radius, i.e. half-width of the cylinder.

void Avogadro::GLPainter::drawLine	(	const Eigen::Vector3d &	start,
		const Eigen::Vector3d &	end,
		double	lineWidth
	)			`[virtual]`

	start	the position of the start of the line.
	end	the position of the end of the line.
	lineWidth	the width of the GL line.

void Avogadro::GLPainter::drawMultiCylinder	(	const Eigen::Vector3d &	end1,
		const Eigen::Vector3d &	end2,
		double	radius,
		int	order,
		double	shift
	)			`[virtual]`

	end1	the position of the first end of the bond.
	end2	the position of the second end of the bond.
	radius	the radius, i.e. half-width of each cylinder.
	order	the multiplicity order of the bond, e.g. 2 for a double bond. When this parameter equals 1, this function is equivalent to drawCylinder().
	shift	how far away from the central axis the cylinders are shifted. In other words this influences the total width of multiple bonds.

void Avogadro::GLPainter::drawMultiLine	(	const Eigen::Vector3d &	start,
		const Eigen::Vector3d &	end,
		double	lineWidth,
		int	order,
		short	stipple
	)			`[virtual]`

void Avogadro::GLPainter::drawQuadrilateral	(	const Eigen::Vector3d &	point1,
		const Eigen::Vector3d &	point2,
		const Eigen::Vector3d &	point3,
		const Eigen::Vector3d &	point4,
		double	lineWidth
	)			`[virtual]`

	point1	the first of the four corners of the quadrilateral.
	point2	the second of the four corners of the quadrilateral.
	point3	the third of the four corners of the quadrilateral.
	point4	the last of the four corners of the quadrilateral.

	pts	QVector containing the points to draw the cubic B-spline along.
	radius	the radius of the cubic B-spline.

	pos	the scene coordinates of the top-left corner of the text to render.
	string	The string to render. All character encodings are allowed but superposed characters are not supported yet. For accented letters, use a character giving the whole accented letter, not a separate character for the accent.

	pos	the window coordinates of the top-left corner of the text to render, (0, 0) is the top-left corner of the window.
	string	the string to render. All character encodings are allowed but superposed characters are not supported yet. For accented letters, use a character giving the whole accented letter, not a separate character for the accent.

void Avogadro::GLPainter::drawShadedQuadrilateral	(	const Eigen::Vector3d &	point1,
		const Eigen::Vector3d &	point2,
		const Eigen::Vector3d &	point3,
		const Eigen::Vector3d &	point4
	)			`[virtual]`

void Avogadro::GLPainter::drawShadedSector	(	const Eigen::Vector3d &	origin,
		const Eigen::Vector3d &	direction1,
		const Eigen::Vector3d &	direction2,
		double	radius,
		bool	alternateAngle = `false`
	)			`[virtual]`

	origin	the center of the circle this sector is a portion of.
	direction1	a vector defining the line the first point will lie on.
	direction2	a vector defining the line the second point will lie on.
	radius	the radius of the circle this sector is a portion of.
	alternateAngle	whether to draw the obtuse angle made by the two vectors instead of the acute angle between them.

void Avogadro::GLPainter::drawSphere	(	const Eigen::Vector3d &	center,
		double	radius
	)			`[virtual]`

	center	the position of the center of the sphere.
	radius	the radius of the sphere.

void Avogadro::GLPainter::drawSpline	(	const QVector< Eigen::Vector3d > &	pts,
		double	radius
	)			`[virtual]`

int Avogadro::GLPainter::drawText	(	const Eigen::Vector3d &	pos,
		const QString &	string
	)			const `[virtual]`

int Avogadro::GLPainter::drawText	(	const QPoint &	pos,
		const QString &	string
	)			const `[virtual]`

	x,y	the window coordinates of the top-left corner of the text to render, (0, 0) is the top-left corner of the window.
	string	the string to render. All character encodings are allowed but superposed characters are not supported yet. For accented letters, use a character giving the whole accented letter, not a separate character for the accent.

void Avogadro::GLPainter::drawTriangle	(	const Eigen::Vector3d &	p1,
		const Eigen::Vector3d &	p2,
		const Eigen::Vector3d &	p3,
		const Eigen::Vector3d &	n
	)			`[virtual]`

kalzium

Avogadro::GLPainter Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

kalzium

kdeedu

	p1	first triangle vertex.
	p2	second triangle vertex.
	p3	third triangle vertex.
	n	the normal of the triangle.

void Avogadro::GLPainter::setColor	(	float	red,
		float	green,
		float	blue,
		float	alpha = `1.0`
	)			`[virtual]`

	red	component of the color.
	green	component of the color.
	blue	component of the color.
	alpha	component of the color.

void Avogadro::GLPainter::setName	(	Primitive::Type	type,
		int	id
	)			`[virtual]`

	type	the primitive type about to be drawn.
	id	the primitive id.