class mrpt::opengl::CArrow

Overview

A 3D arrow.

See also:

opengl::Scene

#include <mrpt/opengl/CArrow.h>

class CArrow: public mrpt::opengl::CRenderizableShaderTriangles
{
public:
    // construction

    CArrow(
        float x0 = 0,
        float y0 = 0,
        float z0 = 0,
        float x1 = 1,
        float y1 = 1,
        float z1 = 1,
        float headRatio = 0.2f,
        float smallRadius = 0.05f,
        float largeRadius = 0.2f
        );

    CArrow(
        const mrpt::math::TPoint3Df& from,
        const mrpt::math::TPoint3Df& to,
        float headRatio = 0.2f,
        float smallRadius = 0.05f,
        float largeRadius = 0.2f
        );

    // methods

    virtual void onUpdateBuffers_Triangles();
    void setName(const std::string& n);
    std::string getName() const;
    bool isVisible() const;
    void setVisibility(bool visible = true);
    bool castShadows() const;
    void castShadows(bool doCast = true);
    void enableShowName(bool showName = true);
    bool isShowNameEnabled() const;
    CRenderizable& setPose(const mrpt::poses::CPose3D& o);
    CRenderizable& setPose(const mrpt::poses::CPose2D& o);
    CRenderizable& setPose(const mrpt::math::TPose3D& o);
    CRenderizable& setPose(const mrpt::math::TPose2D& o);
    CRenderizable& setPose(const mrpt::poses::CPoint3D& o);
    CRenderizable& setPose(const mrpt::poses::CPoint2D& o);
    mrpt::math::TPose3D getPose() const;
    mrpt::poses::CPose3D getCPose() const;
    CRenderizable& setLocation(double x, double y, double z);
    CRenderizable& setLocation(const mrpt::math::TPoint3D& p);
    mrpt::img::TColorf getColor() const;
    mrpt::img::TColor getColor_u8() const;
    CRenderizable& setColorA(const float a);
    virtual CRenderizable& setColorA_u8(const uint8_t a);
    float materialShininess() const;
    void materialShininess(float shininess);
    CRenderizable& setScale(float s);
    CRenderizable& setScale(float sx, float sy, float sz);
    float getScaleX() const;
    float getScaleY() const;
    float getScaleZ() const;
    CRenderizable& setColor(const mrpt::img::TColorf& c);
    CRenderizable& setColor(float R, float G, float B, float A = 1);
    CRenderizable& setColor_u8(uint8_t R, uint8_t G, uint8_t B, uint8_t A = 255);

    void setArrowEnds(
        float x0,
        float y0,
        float z0,
        float x1,
        float y1,
        float z1
        );

    template <typename Vector3Like>
    void setArrowEnds(
        const Vector3Like& start,
        const Vector3Like& end
        );

    void setHeadRatio(float rat);
    void setSmallRadius(float rat);
    void setLargeRadius(float rat);
    void setSlicesCount(uint32_t slices);
    uint32_t getSlicesCount() const;
    virtual mrpt::math::TBoundingBoxf internalBoundingBoxLocal() const;
    virtual shader_list_t requiredShaders() const;
    virtual void render(const RenderContext& rc) const;
    virtual void renderUpdateBuffers() const;
    virtual void freeOpenGLResources();
    virtual bool cullElegible() const;
    virtual void toYAMLMap(mrpt::containers::yaml& propertiesMap) const;

    virtual void enqueueForRenderRecursive(
        ] const mrpt::opengl::TRenderMatrices& state,
        ] RenderQueue& rq,
        ] bool wholeInView,
        ] bool is1stShadowMapPass
        ) const;

    virtual bool isCompositeObject() const;
    void updateBuffers() const;
    void notifyChange() const;
    bool hasToUpdateBuffers() const;
    virtual bool traceRay(const mrpt::poses::CPose3D& o, double& dist) const;
    auto getBoundingBox() const;
    auto getBoundingBoxLocal() const;
    virtual mrpt::math::TPoint3Df getLocalRepresentativePoint() const;
    void setLocalRepresentativePoint(const mrpt::math::TPoint3Df& p);
    mrpt::opengl::CText& labelObject() const;
    virtual void initializeTextures() const;
};

Inherited Members

public:
    // structs

    struct OutdatedState;
    struct RenderContext;
    struct State;

    // methods

    virtual void render(const RenderContext& rc) const = 0;
    virtual void renderUpdateBuffers() const = 0;
    virtual shader_list_t requiredShaders() const;
    virtual void freeOpenGLResources() = 0;
    virtual void onUpdateBuffers_Triangles() = 0;

Construction

CArrow(
    float x0 = 0,
    float y0 = 0,
    float z0 = 0,
    float x1 = 1,
    float y1 = 1,
    float z1 = 1,
    float headRatio = 0.2f,
    float smallRadius = 0.05f,
    float largeRadius = 0.2f
    )

Constructor.

Methods

virtual void onUpdateBuffers_Triangles()

Must be implemented in derived classes to update the geometric entities to be drawn in “m_*_buffer” fields.

void setName(const std::string& n)

Changes the name of the object.

std::string getName() const

Returns the name of the object.

bool isVisible() const

Is the object visible?

See also:

setVisibility

void setVisibility(bool visible = true)

Set object visibility (default=true)

See also:

isVisible

bool castShadows() const

Does the object cast shadows? (default=true)

void castShadows(bool doCast = true)

Enable/disable casting shadows by this object (default=true)

void enableShowName(bool showName = true)

Enables or disables showing the name of the object as a label when rendering.

bool isShowNameEnabled() const

See also:

enableShowName

CRenderizable& setPose(const mrpt::poses::CPose3D& o)

Defines the SE(3) (pose=translation+rotation) of the object with respect to its parent.

CRenderizable& setPose(const mrpt::poses::CPose2D& o)