renderer that supports point splatting More...

#include <box_wire_renderer.h>

Inheritance diagram for cgv::render::box_wire_renderer:

Public Member Functions
void	enable_attribute_array_manager (const context &ctx, attribute_array_manager &aam)
	call this before setting attribute arrays to manage attribute array in given manager

void	disable_attribute_array_manager (const context &ctx, attribute_array_manager &aam)
	call this after last render/draw call to ensure that no other users of renderer change attribute arrays of given manager

void	set_position_is_center (bool _position_is_center)
	set the flag, whether the position is interpreted as the box center

bool	enable (context &ctx)
	enable box wire renderer

template<typename T >
void	set_extent (const context &ctx, const T &extent)
	specify a single extent for all boxes

template<typename T >
void	set_extent_array (const context &ctx, const std::vector< T > &extents)
	extent array specifies box extends in case of position_is_center=true, otherwise the maximum point of each box

template<typename T >
void	set_extent_array (const context &ctx, const T *extents, size_t nr_elements, unsigned stride_in_bytes=0)
	extent array specifies box extends in case of position_is_center=true, otherwise the maximum point of each box

void	remove_extent_array (const context &ctx)
	remove the extent attribute

template<typename T >
void	set_box (const context &ctx, const cgv::media::axis_aligned_box< T, 3 > &box)
	specify a single box. This sets position_is_center to false as well as position and extent attributes

template<typename T >
void	set_box_array (const context &ctx, const std::vector< cgv::media::axis_aligned_box< T, 3 > > &boxes)
	specify box array directly. This sets position_is_center to false as well as position and extent array

template<typename T >
void	set_box_array (const context &ctx, const cgv::media::axis_aligned_box< T, 3 > *boxes, size_t count)
	specify box array directly. This sets position_is_center to false as well as position and extent array

template<typename T >
void	set_translation_array (const context &ctx, const std::vector< T > &translations)
	template method to set the translations from a vector of vectors of type T, which should have 3 components

template<typename T >
void	set_translation_array (const context &ctx, const T *translations, size_t nr_elements, unsigned stride_in_bytes=0)
	template method to set the translations from a vector of vectors of type T, which should have 3 components

void	remove_translation_array (const context &ctx)
	remove the translation attribute

template<typename T >
void	set_rotation_array (const context &ctx, const std::vector< T > &rotations)
	template method to set the rotation from a vector of quaternions of type T, which should have 4 components

template<typename T >
void	set_rotation_array (const context &ctx, const T *rotations, size_t nr_elements, unsigned stride_in_bytes=0)
	template method to set the rotation from a vector of quaternions of type T, which should have 4 components

void	remove_rotation_array (const context &ctx)
	remove the rotation attribute

bool	disable (context &ctx)
	disable renderer

void	draw (context &ctx, size_t start, size_t count, bool use_strips=false, bool use_adjacency=false, uint32_t strip_restart_index=-1)
	Draw a range of vertices or indexed elements.

Public Member Functions inherited from cgv::render::line_renderer
	line_renderer ()
	construct line rendering

bool	enable (context &ctx)
	overload to activate group style

bool	disable (context &ctx)
	disable renderer

void	enable_attribute_array_manager (const context &ctx, attribute_array_manager &aam)
	call this before setting attribute arrays to manage attribute array in given manager

void	disable_attribute_array_manager (const context &ctx, attribute_array_manager &aam)
	call this after last render/draw call to ensure that no other users of renderer change attribute arrays of given manager

bool	init (context &ctx)
	call init() once before using renderer

template<typename T >
void	set_normal (const context &ctx, const cgv::math::fvec< T, 3 > &normal)
	specify a single normal for all lines

template<typename T >
void	set_normal_array (const context &ctx, const std::vector< T > &normals)
	templated method to set the normal attribute from a vector of normals of type T, which should have 3 components

template<typename T >
void	set_normal_array (const context &ctx, const T *normals, size_t nr_elements, unsigned stride_in_bytes=0)
	templated method to set the normal attribute from an array of normals of type T, which should have 3 components

void	remove_normal_array (const context &ctx)
	remove the normal attribute

template<typename T >
void	set_line_width (const context &ctx, const T &line_width)
	specify a single line_width for all lines

template<typename T >
void	set_line_width_array (const context &ctx, const std::vector< T > &line_widths)
	line_width array specifies box extends in case of position_is_center=true, otherwise the maximum point of each box

template<typename T >
void	set_line_width_array (const context &ctx, const T *line_widths, size_t nr_elements, unsigned stride_in_bytes=0)
	line_width array specifies box extends in case of position_is_center=true, otherwise the maximum point of each box

void	remove_line_width_array (const context &ctx)
	remove the line width attribute

template<typename T >
void	set_depth_offset (const context &ctx, const T &depth_offset)
	specify a single depth_offset for all lines

template<typename T >
void	set_depth_offset_array (const context &ctx, const std::vector< T > &depth_offsets)
	depth_offset array specifies box extends in case of position_is_center=true, otherwise the maximum point of each box

template<typename T >
void	set_depth_offset_array (const context &ctx, const T *depth_offsets, size_t nr_elements, unsigned stride_in_bytes=0)
	depth_offset array specifies box extends in case of position_is_center=true, otherwise the maximum point of each box

void	remove_depth_offset_array (const context &ctx)
	remove the depth offset attribute

void	draw (context &ctx, size_t start, size_t count, bool use_strips=false, bool use_adjacency=false, uint32_t strip_restart_index=-1)
	convenience function to render with default settings

Public Member Functions inherited from cgv::render::group_renderer
bool	validate_attributes (const context &ctx) const
	check additionally the group attributes

void	set_group_index_array (const context &ctx, const std::vector< unsigned > &group_indices)
	method to set the group index attribute

void	set_group_index_array (const context &ctx, const unsigned *group_indices, size_t nr_elements)
	method to set the group index attribute

void	set_group_index_array (const context &ctx, type_descriptor element_type, const vertex_buffer &vbo, size_t offset_in_bytes, size_t nr_elements, unsigned stride_in_bytes=0)
	method to set the group index attribute from a vertex buffer object, the element type must be given as explicit template parameter

template<typename T >
void	set_group_index_array (const context &ctx, const vertex_buffer &vbo, size_t offset_in_bytes, size_t nr_elements, unsigned stride_in_bytes=0)
	template method to set the group index color attribute from a vertex buffer object, the element type must be given as explicit template parameter

void	remove_group_index_array (const context &ctx)
	remove the group index attribute

template<typename T >
void	set_group_colors (const context &ctx, const std::vector< T > &colors)
	template method to set the group colors from a vector of colors of type T

template<typename T >
void	set_group_colors (const context &ctx, const T *colors, size_t nr_elements)
	template method to set the group colors from a vector of colors of type T

template<typename T >
void	set_group_translations (const context &ctx, const std::vector< T > &group_translations)
	template method to set the group translations from a vector of vectors of type T, which should have 3 components

template<typename T >
void	set_group_translations (const context &ctx, const T *group_translations, size_t nr_elements)
	template method to set the group translations from a vector of vectors of type T, which should have 3 components

template<typename T >
void	set_group_rotations (const context &ctx, const std::vector< T > &group_rotations)
	template method to set the group rotation from a vector of quaternions of type T, which should have 4 components

template<typename T >
void	set_group_rotations (const context &ctx, const T *group_rotations, size_t nr_elements)
	template method to set the group rotation from a vector of quaternions of type T, which should have 4 components

Public Member Functions inherited from cgv::render::renderer
shader_define_map &	ref_defines ()
	access to shader define map to update defines not handled by render style

shader_program &	ref_prog ()
	derived renderer classes have access to shader program

void	set_prog (shader_program &one_shot_prog)
	set external shader program up to next call to disable() or render()

void	draw_impl (context &ctx, PrimitiveType pt, size_t start, size_t count, bool use_strips=false, bool use_adjacency=false, uint32_t strip_restart_index=-1)
	default implementation of draw method with support for indexed rendering and different primitive types

void	draw_impl_instanced (context &ctx, PrimitiveType type, size_t start, size_t count, size_t instance_count, bool use_strips=false, bool use_adjacency=false, uint32_t strip_restart_index=-1)
	default implementation of instanced draw method with support for indexed rendering and different primitive types

	renderer ()
	construct and init attribute tracking flags

virtual	~renderer ()
	destructor deletes default renderer style

void	manage_singleton (context &ctx, const std::string &renderer_name, int &ref_count, int ref_count_change)
	used by derived classes to manage singletons

virtual void	set_attribute_array_manager (const context &ctx, attribute_array_manager *_aam_ptr=0)
	this function is deprecated, please use enable_attribute_array_manager() and disable_attribute_manager() instead

void	set_render_style (const render_style &rs)
	reference given render style

bool	build_program (context &ctx, shader_program &prog, const render_style &rs)
	build shader program for specific render style

template<typename T >
void	set_position (const context &ctx, const T &position)
	templated method to set the position attribute from a single position of type T

template<typename T >
void	set_position_array (const context &ctx, const std::vector< T > &positions)
	templated method to set the position attribute from a vector of positions of type T

template<typename T >
void	set_position_array (const context &ctx, const T *positions, size_t nr_elements, unsigned stride_in_bytes=0)
	templated method to set the position attribute from a vector of positions of type T

void	set_position_array (const context &ctx, type_descriptor element_type, const vertex_buffer &vbo, size_t offset_in_bytes, size_t nr_elements, unsigned stride_in_bytes)
	method to set the position attribute from a vertex buffer object

template<typename T >
void	set_position_array (const context &ctx, const vertex_buffer &vbo, size_t offset_in_bytes, size_t nr_elements, unsigned stride_in_bytes=0)
	template method to set the position attribute from a vertex buffer object, the element type must be given as explicit template parameter

void	remove_position_array (const context &ctx)
	remove the position attribute

template<typename T >
void	set_color (const context &ctx, const T &color)
	templated method to set the color attribute from a single color of type T

template<typename T >
void	set_color_array (const context &ctx, const std::vector< T > &colors)
	template method to set the color attribute from a vector of colors of type T

template<typename T >
void	set_color_array (const context &ctx, const T *colors, size_t nr_elements, unsigned stride_in_bytes=0)
	template method to set the color attribute from a vector of colors of type T

void	set_color_array (const context &ctx, type_descriptor element_type, const vertex_buffer &vbo, size_t offset_in_bytes, size_t nr_elements, unsigned stride_in_bytes=0)
	method to set the color attribute from a vertex buffer object, the element type must be given as explicit template parameter

template<typename T >
void	set_color_array (const context &ctx, const vertex_buffer &vbo, size_t offset_in_bytes, size_t nr_elements, unsigned stride_in_bytes=0)
	template method to set the color attribute from a vertex buffer object, the element type must be given as explicit template parameter

void	remove_color_array (const context &ctx)
	remove the color attribute

template<typename T >
bool	set_indices (const context &ctx, const std::vector< T > &indices, bool keep_on_cpu=false)
	Set the indices for indexed rendering from a vector.

template<typename T >
bool	set_indices (const context &ctx, const T *indices, size_t nr_indices, bool keep_on_cpu=false)
	Set the indices for indexed rendering from an array given as a pointer.

template<typename T >
bool	set_indices (const context &ctx, const vertex_buffer &vbo, size_t count)
	Set the indices for indexed rendering from a GPU buffer.

bool	has_indices () const
	return whether indices have been defined

void	remove_indices (const context &ctx)
	remove previously set indices

const vertex_buffer *	get_vertex_buffer_ptr (const context &ctx, const attribute_array_manager &aam, const std::string &attr_name)

const vertex_buffer *	get_index_buffer_ptr (const attribute_array_manager &aam)

bool	validate_and_enable (context &ctx)
	validate attributes and if successful, enable renderer

virtual bool	render (context &ctx, size_t start, size_t count, bool use_strips=false, bool use_adjacency=false, uint32_t strip_restart_index=-1)
	Convenience function that draws vertex or indexed element with this renderer.

virtual void	clear (const context &ctx)
	the clear function destructs the shader program

Protected Member Functions
render_style *	create_render_style () const
	overload to allow instantiation of box_wire_renderer

bool	build_shader_program (context &ctx, shader_program &prog, const shader_define_map &defines)
	build box wire program

Protected Member Functions inherited from cgv::render::line_renderer
render_style *	create_render_style () const
	virtual method that creates a default render style

bool	build_shader_program (context &ctx, shader_program &prog, const shader_define_map &defines)
	build line program

Protected Member Functions inherited from cgv::render::renderer
bool	has_aam () const
	check for attribute array manager

bool	has_attribute (const context &ctx, const std::string &name)
	check for attribute

const render_style *	get_style_ptr () const
	access to render style

bool	attributes_persist () const
	return whether attributes persist after a call to disable

virtual void	update_defines (shader_define_map &defines)
	overload to update the shader defines based on the current render style; only called if internal shader program is used

template<typename T >
const T &	get_style () const
	access to style

int	get_prog_attribute_location (const context &ctx, const std::string &name, bool error_check=true)

template<typename T >
bool	set_attribute_array (const context &ctx, const std::string &name, const T &array)

template<typename T >
bool	set_attribute_array (const context &ctx, const std::string &name, const T *array_ptr, size_t nr_elements, unsigned stride)

bool	set_attribute_array (const context &ctx, const std::string &name, type_descriptor element_type, const vertex_buffer &vbo, size_t offset_in_bytes, size_t nr_elements, unsigned stride_in_bytes)

template<typename C , typename T >
bool	set_composed_attribute_array (const context &ctx, const std::string &name, const C *array_ptr, size_t nr_elements, const T &elem)
	in case that several attributes are stored interleaved, call this function for the first and ref_composed_attribute_array() for all others

template<typename C , typename T >
bool	ref_composed_attribute_array (const context &ctx, const std::string &name, const std::string &name_ref, const C *array_ptr, size_t nr_elements, const T &elem)
	in case that several attributes are stored interleaved, call set_composed_attribute_array() for the first and this function for all others

bool	remove_attribute_array (const context &ctx, const std::string &name)

Protected Attributes
bool	has_extents

bool	has_translations
	whether array with per box translations has been specified

bool	has_rotations
	whether array with per box rotations has been specified

bool	position_is_center
	whether position is box center, if not it is lower left bottom corner

Protected Attributes inherited from cgv::render::line_renderer
bool	has_normals

bool	has_line_widths

bool	has_depth_offsets

Protected Attributes inherited from cgv::render::group_renderer
bool	has_group_indices

bool	has_group_colors

bool	has_group_translations

bool	has_group_rotations

Protected Attributes inherited from cgv::render::renderer
bool	has_colors
	track whether color attribute is defined

bool	has_positions
	track whether position attribute is defined

Detailed Description

renderer that supports point splatting

Definition at line 29 of file box_wire_renderer.h.

Constructor & Destructor Documentation

◆ box_wire_renderer()

cgv::render::box_wire_renderer::box_wire_renderer ( )

Definition at line 28 of file box_wire_renderer.cxx.

Member Function Documentation

◆ build_shader_program()

bool cgv::render::box_wire_renderer::build_shader_program	(	context &	ctx,
		shader_program &	prog,
		const shader_define_map &	defines
	)

protectedvirtual

build box wire program

Reimplemented from cgv::render::renderer.

Definition at line 73 of file box_wire_renderer.cxx.

References cgv::render::shader_program::build_program().

◆ create_render_style()

render_style * cgv::render::box_wire_renderer::create_render_style ( ) const

protectedvirtual

overload to allow instantiation of box_wire_renderer

Implements cgv::render::renderer.

Definition at line 23 of file box_wire_renderer.cxx.

◆ disable()

bool cgv::render::box_wire_renderer::disable ( context & ctx )

virtual

disable renderer

Reimplemented from cgv::render::renderer.

Definition at line 92 of file box_wire_renderer.cxx.

References cgv::render::renderer::attributes_persist(), cgv::render::line_renderer::disable(), has_rotations, has_translations, and position_is_center.

◆ disable_attribute_array_manager()

void cgv::render::box_wire_renderer::disable_attribute_array_manager	(	const context &	ctx,
		attribute_array_manager &	aam
	)

virtual

call this after last render/draw call to ensure that no other users of renderer change attribute arrays of given manager

Reimplemented from cgv::render::renderer.

Definition at line 47 of file box_wire_renderer.cxx.

References cgv::render::line_renderer::disable_attribute_array_manager(), has_rotations, and has_translations.

◆ draw()

void cgv::render::box_wire_renderer::draw	(	context &	ctx,
		size_t	start,
		size_t	count,
		bool	use_strips = `false`,
		bool	use_adjacency = `false`,
		uint32_t	strip_restart_index = `-1`
	)

virtual

Draw a range of vertices or indexed elements.

Call this function only successful enabeling via validate_and_enable() or enable(). Capsulates glDrawArrays and glDrawElements calls. Overloaded implementations of specific renderers choose the to be used gl primitive type and whether to use an instanced draw call.

See also: render()

Parameters

count	number of to be drawn vertices/elements
start	index of first to be drawn vertex/element
use_strips	whether to generate primitives in strips (only for line or triangle primitives)
use_adjacency	whether to specify adjacency information (only for line or triangle primitives)
strip_restart_index	extraorindary index used to mark end of strips (only for strip based drawing) Strip based drawing can be combined with the use of adjacency information. Default implementation uses triangle primitives.

Reimplemented from cgv::render::renderer.

Definition at line 104 of file box_wire_renderer.cxx.

References cgv::render::renderer::draw_impl().

◆ enable()

bool cgv::render::box_wire_renderer::enable ( context & ctx )

virtual

enable box wire renderer

Reimplemented from cgv::render::renderer.

Definition at line 78 of file box_wire_renderer.cxx.

References cgv::render::line_renderer::enable(), has_rotations, has_translations, position_is_center, cgv::render::renderer::ref_prog(), cgv::render::shader_program::set_attribute(), and cgv::render::shader_program::set_uniform().

◆ enable_attribute_array_manager()

void cgv::render::box_wire_renderer::enable_attribute_array_manager	(	const context &	ctx,
		attribute_array_manager &	aam
	)

virtual

call this before setting attribute arrays to manage attribute array in given manager

Reimplemented from cgv::render::renderer.

Definition at line 36 of file box_wire_renderer.cxx.

References cgv::render::line_renderer::enable_attribute_array_manager(), cgv::render::renderer::has_attribute(), has_rotations, and has_translations.

◆ remove_extent_array()

void cgv::render::box_wire_renderer::remove_extent_array ( const context & ctx )

remove the extent attribute

Definition at line 54 of file box_wire_renderer.cxx.

◆ remove_rotation_array()

void cgv::render::box_wire_renderer::remove_rotation_array ( const context & ctx )

remove the rotation attribute

Definition at line 62 of file box_wire_renderer.cxx.

References has_rotations.

◆ remove_translation_array()

void cgv::render::box_wire_renderer::remove_translation_array ( const context & ctx )

remove the translation attribute

Definition at line 58 of file box_wire_renderer.cxx.

References has_translations.

◆ set_box()

template<typename T >

void cgv::render::box_wire_renderer::set_box	(	const context &	ctx,
		const cgv::media::axis_aligned_box< T, 3 > &	box
	)

inline

specify a single box. This sets position_is_center to false as well as position and extent attributes

Definition at line 66 of file box_wire_renderer.h.

References cgv::media::axis_aligned_box< T, N >::get_max_pnt(), and cgv::media::axis_aligned_box< T, N >::get_min_pnt().

◆ set_box_array() [1/2]

template<typename T >

void cgv::render::box_wire_renderer::set_box_array	(	const context &	ctx,
		const cgv::media::axis_aligned_box< T, 3 > *	boxes,
		size_t	count
	)

inline

specify box array directly. This sets position_is_center to false as well as position and extent array

Definition at line 82 of file box_wire_renderer.h.

◆ set_box_array() [2/2]

template<typename T >

void cgv::render::box_wire_renderer::set_box_array	(	const context &	ctx,
		const std::vector< cgv::media::axis_aligned_box< T, 3 > > &	boxes
	)

inline

specify box array directly. This sets position_is_center to false as well as position and extent array

Definition at line 73 of file box_wire_renderer.h.

◆ set_extent()

template<typename T >

void cgv::render::box_wire_renderer::set_extent	(	const context &	ctx,
		const T &	extent
	)

inline

specify a single extent for all boxes

Definition at line 55 of file box_wire_renderer.h.

◆ set_extent_array() [1/2]

template<typename T >

void cgv::render::box_wire_renderer::set_extent_array	(	const context &	ctx,
		const std::vector< T > &	extents
	)

inline

extent array specifies box extends in case of position_is_center=true, otherwise the maximum point of each box

Definition at line 58 of file box_wire_renderer.h.

◆ set_extent_array() [2/2]

template<typename T >

void cgv::render::box_wire_renderer::set_extent_array	(	const context &	ctx,
		const T *	extents,
		size_t	nr_elements,
		unsigned	stride_in_bytes = `0`
	)

inline

extent array specifies box extends in case of position_is_center=true, otherwise the maximum point of each box

Definition at line 61 of file box_wire_renderer.h.

◆ set_position_is_center()

void cgv::render::box_wire_renderer::set_position_is_center ( bool _position_is_center )

set the flag, whether the position is interpreted as the box center

Definition at line 67 of file box_wire_renderer.cxx.

References position_is_center.

◆ set_rotation_array() [1/2]

template<typename T >

void cgv::render::box_wire_renderer::set_rotation_array	(	const context &	ctx,
		const std::vector< T > &	rotations
	)

inline

template method to set the rotation from a vector of quaternions of type T, which should have 4 components

Definition at line 99 of file box_wire_renderer.h.

◆ set_rotation_array() [2/2]

template<typename T >

void cgv::render::box_wire_renderer::set_rotation_array	(	const context &	ctx,
		const T *	rotations,
		size_t	nr_elements,
		unsigned	stride_in_bytes = `0`
	)

inline

template method to set the rotation from a vector of quaternions of type T, which should have 4 components

Definition at line 102 of file box_wire_renderer.h.

◆ set_translation_array() [1/2]

template<typename T >

void cgv::render::box_wire_renderer::set_translation_array	(	const context &	ctx,
		const std::vector< T > &	translations
	)

inline

template method to set the translations from a vector of vectors of type T, which should have 3 components

Definition at line 91 of file box_wire_renderer.h.

◆ set_translation_array() [2/2]

template<typename T >

void cgv::render::box_wire_renderer::set_translation_array	(	const context &	ctx,
		const T *	translations,
		size_t	nr_elements,
		unsigned	stride_in_bytes = `0`
	)

inline

template method to set the translations from a vector of vectors of type T, which should have 3 components

Definition at line 94 of file box_wire_renderer.h.

Member Data Documentation

◆ has_extents

bool cgv::render::box_wire_renderer::has_extents

protected

Definition at line 32 of file box_wire_renderer.h.

◆ has_rotations

bool cgv::render::box_wire_renderer::has_rotations

protected

whether array with per box rotations has been specified

Definition at line 36 of file box_wire_renderer.h.

Referenced by disable(), disable_attribute_array_manager(), enable(), enable_attribute_array_manager(), and remove_rotation_array().

◆ has_translations

bool cgv::render::box_wire_renderer::has_translations

protected

whether array with per box translations has been specified

Definition at line 34 of file box_wire_renderer.h.

Referenced by disable(), disable_attribute_array_manager(), enable(), enable_attribute_array_manager(), and remove_translation_array().

◆ position_is_center

bool cgv::render::box_wire_renderer::position_is_center

protected

whether position is box center, if not it is lower left bottom corner

Definition at line 38 of file box_wire_renderer.h.

Referenced by disable(), enable(), and set_position_is_center().

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

libs/cgv_gl/box_wire_renderer.h
libs/cgv_gl/box_wire_renderer.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ box_wire_renderer()

Member Function Documentation

◆ build_shader_program()

◆ create_render_style()

◆ disable()

◆ disable_attribute_array_manager()

◆ draw()

◆ enable()

◆ enable_attribute_array_manager()

◆ remove_extent_array()

◆ remove_rotation_array()

◆ remove_translation_array()

◆ set_box()

◆ set_box_array() [1/2]

◆ set_box_array() [2/2]

◆ set_extent()

◆ set_extent_array() [1/2]

◆ set_extent_array() [2/2]

◆ set_position_is_center()

◆ set_rotation_array() [1/2]

◆ set_rotation_array() [2/2]

◆ set_translation_array() [1/2]

◆ set_translation_array() [2/2]

Member Data Documentation

◆ has_extents

◆ has_rotations

◆ has_translations

◆ position_is_center