TissueForge::shaders::Flat3D Class Reference

Inheritance diagram for TissueForge::shaders::Flat3D:

Collaboration diagram for TissueForge::shaders::Flat3D:

Public Types
enum	: UnsignedInt { ColorOutput = Magnum::Shaders::Generic3D::ColorOutput , ObjectIdOutput = Magnum::Shaders::Generic3D::ObjectIdOutput }
enum class	Flag : UnsignedByte {   Textured = 1 << 0 , AlphaMask = 1 << 1 , VertexColor = 1 << 2 , TextureTransformation = 1 << 3 ,   ObjectId = 1 << 4 , InstancedObjectId = (1 << 5)|ObjectId , InstancedTransformation = 1 << 6 , InstancedTextureOffset = (1 << 7)|TextureTransformation }
typedef Magnum::Shaders::Generic3D::Position	Position
	Vertex position.
typedef Magnum::Shaders::Generic3D::TextureCoordinates	TextureCoordinates
	2D texture coordinates
typedef Magnum::Shaders::Generic3D::Color3	Color3
	Three-component vertex color.
typedef Magnum::Shaders::Generic3D::Color4	Color4
	Four-component vertex color.
typedef Magnum::Shaders::Generic3D::ObjectId	ObjectId
	(Instanced) object ID
typedef Magnum::Shaders::Generic3D::TransformationMatrix	TransformationMatrix
	(Instanced) transformation matrix
typedef Magnum::Shaders::Generic3D::TextureOffset	TextureOffset
	(Instanced) texture offset
typedef Containers::EnumSet< Flag >	Flags

Public Member Functions
	Flat3D (Flags flags={}, unsigned clipPlaneCount=0)
	Constructor.
	Flat3D (NoCreateT) noexcept
	Construct without creating the underlying OpenGL object.
	Flat3D (const Flat3D &)=delete
	Copying is not allowed.
	Flat3D (Flat3D &&) noexcept=default
	Move constructor.
Flat3D &	operator= (const Flat3D &)=delete
	Copying is not allowed.
Flat3D &	operator= (Flat3D &&) noexcept=default
	Move assignment.
Flags	flags () const
	Flags.
Flat3D &	setTransformationProjectionMatrix (const MatrixTypeFor< 3, Float > &matrix)
	Set transformation and projection matrix.
Flat3D &	setTextureMatrix (const Matrix3 &matrix)
	Set texture coordinate transformation matrix.
Flat3D &	setColor (const Magnum::Color4 &color)
	Set color.
Flat3D &	bindTexture (GL::Texture2D &texture)
	Bind a color texture.
Flat3D &	setAlphaMask (Float mask)
	Set alpha mask value.
Flat3D &	setclipPlaneEquation (UnsignedInt id, const Vector4 &position)
	Set clip plane equation for given clip plane.
Flat3D &	setObjectId (UnsignedInt id)
	Set object ID.
unsigned	clipPlaneCount () const

Member Enumeration Documentation

anonymous enum

anonymous enum : UnsignedInt

Enumerator
ColorOutput	Color shader output.
ObjectIdOutput	Object ID shader output.

Constructor & Destructor Documentation

Flat3D()

TissueForge::shaders::Flat3D::Flat3D ( Flags flags = {}, unsigned clipPlaneCount = 0 )

explicit

Constructor.

Parameters

flags

Flags

Member Function Documentation

bindTexture()

Flat3D & TissueForge::shaders::Flat3D::bindTexture

(

GL::Texture2D &

texture

)

Bind a color texture.

Returns

Reference to self (for method chaining)

setAlphaMask()

Flat3D & TissueForge::shaders::Flat3D::setAlphaMask

(

Float

mask

)

Set alpha mask value.

Returns

Reference to self (for method chaining)

setclipPlaneEquation()

Flat3D & TissueForge::shaders::Flat3D::setclipPlaneEquation	(	UnsignedInt	id,
		const Vector4 &	position )

Set clip plane equation for given clip plane.

Returns

Reference to self (for method chaining)

setColor()

Flat3D & TissueForge::shaders::Flat3D::setColor

(

const Magnum::Color4 &

color

)

Set color.

Returns

Reference to self (for method chaining)

setObjectId()

Flat3D & TissueForge::shaders::Flat3D::setObjectId

(

UnsignedInt

id

)

Set object ID.

Returns

Reference to self (for method chaining)

setTextureMatrix()

Flat3D & TissueForge::shaders::Flat3D::setTextureMatrix

(

const Matrix3 &

matrix

)

Set texture coordinate transformation matrix.

Returns

Reference to self (for method chaining)

setTransformationProjectionMatrix()

Flat3D & TissueForge::shaders::Flat3D::setTransformationProjectionMatrix

(

const MatrixTypeFor< 3, Float > &

matrix

)

Set transformation and projection matrix.

Returns

Reference to self (for method chaining)

Initial value is an identity matrix.

---

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

• source/shaders/tfFlat3D.h