ion::gfxutils::Printer Class Reference

The Printer class can be used for debugging. More...

#include "printer.h"

Public Types
enum	Format {   kText,   kHtml }
	Available output formats. More...

Public Member Functions
	Printer ()
	Printer class functions. More...
	~Printer ()
void	SetFormat (Format format)
	Sets/returns the printed format. The default is kText. More...
Format	GetFormat () const
void	EnableFullShapePrinting (bool enable)
	Sets/returns a flag indicating whether shape contents should be written. More...
bool	IsFullShapePrintingEnabled () const
void	EnableAddressPrinting (bool enable)
	Sets/returns a flag indicating whether the addresses of objects should be written. More...
bool	IsAddressPrintingEnabled () const
void	PrintScene (const gfx::NodePtr &node, std::ostream &out)
	Prints the scene graph rooted by the given node. More...

Detailed Description

The Printer class can be used for debugging.

It prints ION scene graphs to a stream.

Definition at line 31 of file printer.h.

Member Enumeration Documentation

enum ion::gfxutils::Printer::Format

Available output formats.

Todo:

(user): Implement HTML format.

Enumerator
kText
kHtml

Definition at line 35 of file printer.h.

Constructor & Destructor Documentation

ion::gfxutils::Printer::Printer

(

)

Printer class functions.

Definition at line 1548 of file printer.cc.

ion::gfxutils::Printer::~Printer

(

)

Definition at line 1554 of file printer.cc.

Member Function Documentation

void ion::gfxutils::Printer::EnableAddressPrinting ( bool  enable )

inline

Sets/returns a flag indicating whether the addresses of objects should be written.

The default is true.

Definition at line 57 of file printer.h.

References address_printing_enabled_.

void ion::gfxutils::Printer::EnableFullShapePrinting ( bool  enable )

inline

Sets/returns a flag indicating whether shape contents should be written.

The default is false.

Definition at line 48 of file printer.h.

References full_shape_printing_enabled_.

Format ion::gfxutils::Printer::GetFormat ( ) const

inline

Definition at line 44 of file printer.h.

bool ion::gfxutils::Printer::IsAddressPrintingEnabled ( ) const

inline

Definition at line 60 of file printer.h.

References address_printing_enabled_.

bool ion::gfxutils::Printer::IsFullShapePrintingEnabled ( ) const

inline

Definition at line 51 of file printer.h.

References full_shape_printing_enabled_.

void ion::gfxutils::Printer::PrintScene	(	const gfx::NodePtr &	node,
		std::ostream &	out
	)

Prints the scene graph rooted by the given node.

Definition at line 1558 of file printer.cc.

References kText.

void ion::gfxutils::Printer::SetFormat ( Format  format )

inline

Sets/returns the printed format. The default is kText.

Definition at line 43 of file printer.h.

---

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

• gfxutils/printer.h
• gfxutils/printer.cc