Class: ewol::Shaper

Synopsis:

+                       Shaper                     (const std::string & _shaperName);
+                      ~Shaper                     (void);
+  void                 draw                       (bool _disableDepthTest);
+  void                 clear                      (void);
+  bool                 changeStatusIn             (int32_t _newStatusId);
+  int32_t              getCurrentDisplayedStatus  (void);
+  int32_t              getNextDisplayedStatus     (void);
+  float                getTransitionStatus        (void);
+  bool                 periodicCall               (const ewol::EventTime & _event);
+  void                 setOrigin                  (const vec2 & _newOri);
+  void                 setSize                    (const vec2 & _newSize);
+  void                 setInsideSize              (const vec2 & _newInsideSize);
+  void                 setInsidePos               (const vec2 & _newInsidePos);
+  vec2                 getPadding                 (void);
+  void                 setSource                  (const std::string & _newFile);
+  const std::string &  getSource                  (void);
+  bool                 hasSources                 (void);
-  void                 loadProgram                (void);
-  void                 unLoadProgram              (void);
-  void                 updateVertex               (void);

Object Hierarchy:

ewol::Compositing
    +--> ewol::Shaper

Description:

/** * @brief the Shaper system is a basic theme configuration for every widget, it corespond at a background display described by a pool of files */

Detail:

ewol::Shaper ()

Shaper(const std::string & _shaperName);

generic constructor

Parameter [input]: _shaperName Name of the file that might be loaded

---

ewol::~Shaper ()

~Shaper(void);

generic destructor

---

draw ()

void draw(bool _disableDepthTest);

draw All the refistered text in the current element on openGL

---

clear ()

void clear(void);

clear alll tre registered element in the current element

---

changeStatusIn ()

bool changeStatusIn(int32_t _newStatusId);

change the current status in an other

Parameter [input]: _newStatusId the next new status requested
Return: true The widget must call this fuction periodicly (and redraw itself)
Return: false No need to request the periodic call.

---

getCurrentDisplayedStatus ()

int32_t getCurrentDisplayedStatus(void);

get the current displayed status of the shaper

Return: The Status Id

---

getNextDisplayedStatus ()

int32_t getNextDisplayedStatus(void);

get the next displayed status of the shaper

Return: The next status Id (-1 if no status in next)

---

getTransitionStatus ()

float getTransitionStatus(void);

get the current trasion status

Return: value of the transition status (0.0f when no activity)

---

periodicCall ()

bool periodicCall(const ewol::EventTime & _event);

Same as the widfget periodic call (this is for change display)

Parameter [input]: _event The current time of the call.
Return: true The widget must call this fuction periodicly (and redraw itself)
Return: false No need to request the periodic call.

---

setOrigin ()

void setOrigin(const vec2 & _newOri);

set the widget origin (needed fot the display)

Parameter [input]: _newOri : the new widget origin

---

setSize ()

void setSize(const vec2 & _newSize);

set the widget size (needed fot the display)

Parameter [input]: _newSize : the new widget size

---

setInsideSize ()

void setInsideSize(const vec2 & _newInsideSize);

set the internal widget size

Parameter [input]: _newInsidePos : the subelement size.

---

setInsidePos ()

void setInsidePos(const vec2 & _newInsidePos);

set the internal widget position

Parameter [input]: _newInsidePos : the subelement position

---

getPadding ()

vec2 getPadding(void);

get the padding declared by the user in the config file

Return: the padding property

---

setSource ()

void setSource(const std::string & _newFile);

change the shaper Source

Parameter [input]: _newFile New file of the shaper

---

getSource ()

const std::string & getSource(void);

get the shaper file Source

Return: the shapper file name

---

hasSources ()

bool hasSources(void);

Sometimes the user declare an image but not allocate the ressources all the time, this is to know it ..

Return: the validity od the resources.

---

loadProgram ()

void loadProgram(void);

load the openGL program and get all the ID needed

---

unLoadProgram ()

void unLoadProgram(void);

Un-Load the openGL program and get all the ID needed

---

updateVertex ()

void updateVertex(void);

update the internal vertex table.

---