Container interface of UI Shapes. More...

#include <Container.hpp>

Collaboration diagram for gamp::graph::ui::Container:

Public Member Functions
virtual void	addShape (const ShapeRef &s) const noexcept=0
	Adds a `Shape`.

virtual void	addShapes (const ShapeList &shapes)=0
	Removes given shape with `Shape#destroy(GL2ES2, RegionRenderer)`, if contained.

virtual const AABBox3f &	bounds (const PMVMat4f &pmv, const Shape &shape) const noexcept=0
	Returns `AABBox` dimension of given `Shape` from this container's perspective, i.e.

virtual bool	contains (const Shape &s)=0

virtual Shape &	getShapeByID (int id) const noexcept=0

virtual Shape &	getShapeByIdx (int id) const noexcept=0

virtual Shape &	getShapeByName (const std::string &name) const noexcept=0

virtual bool	isCullingEnabled () const noexcept=0
	Return whether `Project-Modelview (PMv) frustum culling` or `Group's Modelview (Mv) frustum clipping` is enabled for this container.

virtual bool	isOutside (const PMVMat4f &, const Shape &shape) const noexcept=0
	Returns whether the given `Shape` is completely outside of this container.

virtual bool	isOutside2 (const Mat4f &mvCont, const Shape &shape, const PMVMat4f &) const noexcept=0
	Returns whether the given `Shape` is completely outside of this container.

virtual bool	isPMvCullingEnabled () const noexcept=0
	Return whether `Project-Modelview (PMv) frustum culling` is enabled for this container.

virtual void	removeAllShapes (RenderContext &rc, RegionRenderer &renderer)=0
	Removes all contained shapes with `Shape#destroy(GL2ES2, RegionRenderer)`.

virtual ShapeRef	removeShape (const ShapeRef &s) const noexcept=0
	Removes given shape, w/o `Shape#destroy(GL2ES2, RegionRenderer)`.

virtual void	removeShapes (const ShapeList &shapes)=0
	Removes all given shapes, w/o `Shape#destroy(GL2ES2, RegionRenderer)`.

virtual void	removeShapes (RenderContext &rc, RegionRenderer &renderer, const ShapeList &shapes)=0
	Removes all given shapes with `Shape#destroy(GL2ES2, RegionRenderer)`.

virtual ShapeList &	renderedShapes () const noexcept=0
	Returns `added shapes` which are rendered and sorted by z-axis in ascending order toward z-near.

virtual void	setPMvCullingEnabled (bool v) noexcept=0
	Enable or disable `Project-Modelview (PMv) frustum` culling per `Shape` for this container.

virtual size_t	shapeCount () const noexcept=0
	Returns number of `Shape`s, see `getShapes()`.

virtual const ShapeList &	shapes () const noexcept=0
	Returns `added` `Shape`s.

Detailed Description

Container interface of UI Shapes.

See also: Scene; Shape

Definition at line 59 of file Container.hpp.

Member Function Documentation

◆ shapeCount()

virtual size_t gamp::graph::ui::Container::shapeCount ( ) const

pure virtualnoexcept

Returns number of Shapes, see getShapes().

◆ shapes()

virtual const ShapeList & gamp::graph::ui::Container::shapes ( ) const

pure virtualnoexcept

Returns added Shapes.

Here is the caller graph for this function:

◆ renderedShapes()

virtual ShapeList & gamp::graph::ui::Container::renderedShapes ( ) const

pure virtualnoexcept

Returns added shapes which are rendered and sorted by z-axis in ascending order toward z-near.

The rendered shapes are visible and not deemed outside of this container due to culling.

Only rendered shapes are considered for picking/activation.

The returned list is data-race free, i.e. won't be mutated by the rendering thread as it gets completely replace at each rendering loop using a local volatile reference.
Only when disposing the container, the list gets cleared, hence {@Link List#size()} shall be used in the loop.

See also: #addShape(Shape); isCullingEnabled(); Shape#isVisible(); #isOutside(PMVMatrix4f, Shape)

Here is the caller graph for this function:

◆ addShape()

virtual void gamp::graph::ui::Container::addShape ( const ShapeRef & s ) const

pure virtualnoexcept

Adds a Shape.

Here is the caller graph for this function:

◆ removeShape()

virtual ShapeRef gamp::graph::ui::Container::removeShape ( const ShapeRef & s ) const

pure virtualnoexcept

Removes given shape, w/o Shape#destroy(GL2ES2, RegionRenderer).

Returns: the removed shape or null if not contained

Here is the caller graph for this function:

◆ removeShapes() [1/2]

virtual void gamp::graph::ui::Container::removeShapes ( const ShapeList & shapes )

pure virtual

Removes all given shapes, w/o Shape#destroy(GL2ES2, RegionRenderer).

Here is the caller graph for this function:

◆ addShapes()

virtual void gamp::graph::ui::Container::addShapes ( const ShapeList & shapes )

pure virtual

Removes given shape with Shape#destroy(GL2ES2, RegionRenderer), if contained.

Parameters

gl	GL2ES2 context
renderer
s	the shape to be removed

Returns: true if given Shape is removed and destroyed

Here is the caller graph for this function:

◆ removeShapes() [2/2]

virtual void gamp::graph::ui::Container::removeShapes	(	RenderContext &	rc,
		RegionRenderer &	renderer,
		const ShapeList &	shapes )

pure virtual

Removes all given shapes with Shape#destroy(GL2ES2, RegionRenderer).

◆ removeAllShapes()

virtual void gamp::graph::ui::Container::removeAllShapes	(	RenderContext &	rc,
		RegionRenderer &	renderer )

pure virtual

Removes all contained shapes with Shape#destroy(GL2ES2, RegionRenderer).

Here is the caller graph for this function:

◆ contains()

virtual bool gamp::graph::ui::Container::contains ( const Shape & s )

pure virtual

Here is the caller graph for this function:

◆ getShapeByIdx()

virtual Shape & gamp::graph::ui::Container::getShapeByIdx ( int id ) const

pure virtualnoexcept

Here is the caller graph for this function:

◆ getShapeByID()

virtual Shape & gamp::graph::ui::Container::getShapeByID ( int id ) const

pure virtualnoexcept

Here is the caller graph for this function:

◆ getShapeByName()

virtual Shape & gamp::graph::ui::Container::getShapeByName ( const std::string & name ) const

pure virtualnoexcept

Here is the caller graph for this function:

◆ bounds()

virtual const AABBox3f & gamp::graph::ui::Container::bounds	(	const PMVMat4f &	pmv,
		const Shape &	shape ) const

pure virtualnoexcept

Returns AABBox dimension of given Shape from this container's perspective, i.e.

world-bounds if performing from the Scene.

Here is the caller graph for this function:

◆ setPMvCullingEnabled()

virtual void gamp::graph::ui::Container::setPMvCullingEnabled ( bool v )

pure virtualnoexcept

Enable or disable Project-Modelview (PMv) frustum culling per Shape for this container.

Default is disabled.

Here is the caller graph for this function:

◆ isPMvCullingEnabled()

virtual bool gamp::graph::ui::Container::isPMvCullingEnabled ( ) const

pure virtualnoexcept

Return whether Project-Modelview (PMv) frustum culling is enabled for this container.

Here is the caller graph for this function:

◆ isCullingEnabled()

virtual bool gamp::graph::ui::Container::isCullingEnabled ( ) const

pure virtualnoexcept

Return whether Project-Modelview (PMv) frustum culling or Group's Modelview (Mv) frustum clipping is enabled for this container.

Default is disabled.

Here is the caller graph for this function:

◆ isOutside()

virtual bool gamp::graph::ui::Container::isOutside	(	const PMVMat4f &	,
		const Shape &	shape ) const

pure virtualnoexcept

Returns whether the given Shape is completely outside of this container.

Note: If method returns false, the box may only be partially inside, i.e. intersects with this container

Parameters

pmv	current `PMVMatrix4f` of this container
shape	the `Shape` to test

See also: #isOutside2(Matrix4f, Shape, PMVMatrix4f); Shape#isOutside()

Here is the caller graph for this function:

◆ isOutside2()

virtual bool gamp::graph::ui::Container::isOutside2	(	const Mat4f &	mvCont,
		const Shape &	shape,
		const PMVMat4f &	) const

pure virtualnoexcept

Returns whether the given Shape is completely outside of this container.

Note: If method returns false, the box may only be partially inside, i.e. intersects with this container

Parameters

mvCont	copy of the model-view `of this container shape the Shape` to test
pmvShape	current `PMVMatrix4f` of the shape to test

See also: #isOutside(PMVMatrix4f, Shape); Shape#isOutside()

Here is the caller graph for this function:

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

include/gamp/graph/ui/Container.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ shapeCount()

◆ shapes()

◆ renderedShapes()

◆ addShape()

◆ removeShape()

◆ removeShapes() [1/2]

◆ addShapes()

◆ removeShapes() [2/2]

◆ removeAllShapes()

◆ contains()

◆ getShapeByIdx()

◆ getShapeByID()

◆ getShapeByName()

◆ bounds()

◆ setPMvCullingEnabled()

◆ isPMvCullingEnabled()

◆ isCullingEnabled()

◆ isOutside()

◆ isOutside2()