Visual Computing Library  devel
Loading...
Searching...
No Matches
vcl::DrawableMeshOpenGL2< MeshType > Class Template Reference
Inheritance diagram for vcl::DrawableMeshOpenGL2< MeshType >:

Public Member Functions

Box3d boundingBox () const override
 This member function is used to find a good camera position to render object. It should return the the bounding box of the object. Return a null bounding box if the object shouldn't influence the position of the camera.
 
std::shared_ptr< DrawableObjectclone () &&override
 This member function is used to create a new DrawableObject that is a moved from the current one. This object will be destroyed after the call of this function. Each derived class must implement this member function, that returns a shared pointer pointing to the moved object. For more details about this paradigm, check polimorphism clone in modern c++: https://www.fluentcpp.com/2017/09/08/make-polymorphic-copy-modern-cpp/.
 
std::shared_ptr< DrawableObjectclone () const &override
 This member function is used to create a new copy of the DrawableObject. Each derived class must implement this member function, that returns a shared pointer pointing to a copy of the current one. for more details about this paradigm, check polimorphism clone in modern c++: https://www.fluentcpp.com/2017/09/08/make-polymorphic-copy-modern-cpp/.
 
void draw (uint) const override
 This member function must draw the object. It will be called at every frame.
 
 DrawableMeshOpenGL2 (const MeshType &mesh)
 
 DrawableMeshOpenGL2 (MeshType &&mesh)
 
uint edgeNumber () const override
 
uint faceNumber () const override
 
void init () override
 This member function is called after the initialization of the Context. It must initialize and bind data to the GPU like buffers and textures.
 
const std::string & name () const override
 Returns the name of the object.
 
std::string & name () override
 Returns a reference of the name of the object, that allows to modify it.
 
void swap (DrawableMeshOpenGL2 &other)
 
std::vector< std::string > textures () const override
 
vcl::Matrix44d transformMatrix () const override
 
void updateBuffers (MRI::BuffersBitSet buffersToUpdate=MRI::BUFFERS_ALL) override
 
uint vertexNumber () const override
 
- Public Member Functions inherited from vcl::AbstractDrawableMesh
 AbstractDrawableMesh (const AbstractDrawableMesh &other)=default
 
template<MeshConcept MeshType>
 AbstractDrawableMesh (const MeshType &m)
 
bool isVisible () const
 This member function is used to check if the object is visible.
 
const MeshRenderSettingsrenderSettings () const
 
virtual void setRenderSettings (const MeshRenderSettings &rs)
 
void setVisibility (bool vis)
 This member function is used to set the visibility of the object.
 
- Public Member Functions inherited from vcl::DrawableObject
 DrawableObject ()=default
 Empty constructor.
 
virtual void drawId (uint viewId, uint id) const
 This member function should draw the object. It will be called on request when the renderer needs to draw the ID of the object.
 
std::string & info ()
 Returns a reference of the info of the object, that allows to modify it.
 
const std::string & info () const
 Returns the info of the object.
 

Private Types

using MRI = MeshRenderInfo
 

Private Member Functions

void bindTextures ()
 
void renderPass () const
 
void unbindTextures ()
 

Private Attributes

Box3d mBoundingBox
 
MeshRenderVectors< MeshType > mMRD
 
std::vector< uint > mTextID
 

Friends

void swap (DrawableMeshOpenGL2 &a, DrawableMeshOpenGL2 &b)
 

Additional Inherited Members

- Protected Member Functions inherited from vcl::AbstractDrawableMesh
void swap (AbstractDrawableMesh &other)
 
- Protected Member Functions inherited from vcl::DrawableObject
void swap (DrawableObject &other)
 Utility swap function that allows to swap the content of two DrawableObject instances.
 
- Protected Attributes inherited from vcl::AbstractDrawableMesh
MeshRenderSettings mMRS
 

Member Function Documentation

◆ boundingBox()

template<MeshConcept MeshType>
Box3d vcl::DrawableMeshOpenGL2< MeshType >::boundingBox ( ) const
inlineoverridevirtual

This member function is used to find a good camera position to render object. It should return the the bounding box of the object. Return a null bounding box if the object shouldn't influence the position of the camera.

Returns
The bounding box of the object.

Implements vcl::DrawableObject.

◆ clone() [1/2]

template<MeshConcept MeshType>
std::shared_ptr< DrawableObject > vcl::DrawableMeshOpenGL2< MeshType >::clone ( ) &&
inlineoverridevirtual

This member function is used to create a new DrawableObject that is a moved from the current one. This object will be destroyed after the call of this function. Each derived class must implement this member function, that returns a shared pointer pointing to the moved object. For more details about this paradigm, check polimorphism clone in modern c++: https://www.fluentcpp.com/2017/09/08/make-polymorphic-copy-modern-cpp/.

Generally, if your class that inherits from DrawableObject is called MyObject, the clone member function should be implemented as follows:

std::shared_ptr<DrawableObject> MyObject::clone() &&
{
return std::make_shared<MyObject>(std::move(*this));
}
Returns
A shared pointers that points to a new DrawableObject that is a moved from the current one.

Implements vcl::DrawableObject.

◆ clone() [2/2]

template<MeshConcept MeshType>
std::shared_ptr< DrawableObject > vcl::DrawableMeshOpenGL2< MeshType >::clone ( ) const &
inlineoverridevirtual

This member function is used to create a new copy of the DrawableObject. Each derived class must implement this member function, that returns a shared pointer pointing to a copy of the current one. for more details about this paradigm, check polimorphism clone in modern c++: https://www.fluentcpp.com/2017/09/08/make-polymorphic-copy-modern-cpp/.

Generally, if your class that inherits from DrawableObject is called MyObject, the clone member function should be implemented as follows:

std::shared_ptr<DrawableObject> MyObject::clone() const&
{
return std::make_shared<MyObject>(*this);
}
A class representing a box in N-dimensional space.
Definition box.h:46
Returns
A shared pointers that points to a new DrawableObject that is a copy of the current one.

Implements vcl::DrawableObject.

◆ draw()

template<MeshConcept MeshType>
void vcl::DrawableMeshOpenGL2< MeshType >::draw ( uint  viewId) const
inlineoverridevirtual

This member function must draw the object. It will be called at every frame.

Parameters
viewIdThe ID of the view to draw. It may be used depending on the rendering engine.

Implements vcl::DrawableObject.

◆ edgeNumber()

template<MeshConcept MeshType>
uint vcl::DrawableMeshOpenGL2< MeshType >::edgeNumber ( ) const
inlineoverridevirtual

◆ faceNumber()

template<MeshConcept MeshType>
uint vcl::DrawableMeshOpenGL2< MeshType >::faceNumber ( ) const
inlineoverridevirtual

◆ init()

template<MeshConcept MeshType>
void vcl::DrawableMeshOpenGL2< MeshType >::init ( )
inlineoverridevirtual

This member function is called after the initialization of the Context. It must initialize and bind data to the GPU like buffers and textures.

Reimplemented from vcl::DrawableObject.

◆ name() [1/2]

template<MeshConcept MeshType>
const std::string & vcl::DrawableMeshOpenGL2< MeshType >::name ( ) const
inlineoverridevirtual

Returns the name of the object.

Returns
The name of the object.

Reimplemented from vcl::DrawableObject.

◆ name() [2/2]

template<MeshConcept MeshType>
std::string & vcl::DrawableMeshOpenGL2< MeshType >::name ( )
inlineoverridevirtual

Returns a reference of the name of the object, that allows to modify it.

Parameters
[in]nameThe name of the object.

Reimplemented from vcl::DrawableObject.

◆ textures()

template<MeshConcept MeshType>
std::vector< std::string > vcl::DrawableMeshOpenGL2< MeshType >::textures ( ) const
inlineoverridevirtual

Reimplemented from vcl::AbstractDrawableMesh.

◆ transformMatrix()

template<MeshConcept MeshType>
vcl::Matrix44d vcl::DrawableMeshOpenGL2< MeshType >::transformMatrix ( ) const
inlineoverridevirtual

◆ updateBuffers()

template<MeshConcept MeshType>
void vcl::DrawableMeshOpenGL2< MeshType >::updateBuffers ( MRI::BuffersBitSet  buffersToUpdate = MRI::BUFFERS_ALL)
inlineoverridevirtual

◆ vertexNumber()

template<MeshConcept MeshType>
uint vcl::DrawableMeshOpenGL2< MeshType >::vertexNumber ( ) const
inlineoverridevirtual

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