class: ewol::compositing::Shaper
Description:
the Shaper system is a basic theme configuration for every widget, it corespond at a background display described by a pool of filesConstructor and Destructor:
+ Shaper (const std::string & _shaperName);
+ virtual ~Shaper ();
Synopsis:
+ void draw (bool _disableDepthTest);
+ void clear ();
+ bool changeStatusIn (int32_t _newStatusId);
+ int32_t getCurrentDisplayedStatus ();
+ int32_t getNextDisplayedStatus ();
+ float getTransitionStatus ();
+ bool periodicCall (const ewol::event::Time & _event);
+ ewol::Padding getPadding ();
+ ewol::Padding getPaddingIn ();
+ ewol::Padding getPaddingOut ();
+ ewol::Padding getBorder ();
+ void setSource (const std::string & _newFile);
+ const std::string & getSource () const;
+ bool hasSources ();
+ void setShape (const vec2 & _origin,
const vec2 & _size,
const vec2 & _insidePos,
const vec2 & _insideSize);
+ void setShape (const vec2 & _origin,
const vec2 & _size);
+ int32_t requestColor (const std::string & _name);
+ const etk::Color<float> & getColor (int32_t _id);
+ int32_t requestConfig (const std::string & _name);
+ double getConfigNumber (int32_t _id);
+ void setActivateState (int32_t _status);
+ bool operator == (const Shaper & _obj) const;
+ bool operator != (const Shaper & _obj) const;
Object Hierarchy:
+ewol::Compositing
+--> ewol::compositing::Shaper
Detail:
Shaper
+ Shaper (const std::string & _shaperName);
generic constructor
Parameter [input]: _shaperName Name of the file that might be loaded
~Shaper
+ virtual ~Shaper ();
generic destructor
draw
+ void draw (bool _disableDepthTest);
draw All the refistered text in the current element on openGL
clear
+ void clear ();
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)<br/>false No need to request the periodic call.
getCurrentDisplayedStatus
+ int32_t getCurrentDisplayedStatus ();
get the current displayed status of the shaper
Return: The Status Id
getNextDisplayedStatus
+ int32_t getNextDisplayedStatus ();
get the next displayed status of the shaper
Return: The next status Id (-1 if no status in next)
getTransitionStatus
+ float getTransitionStatus ();
get the current trasion status
Return: value of the transition status (0.0f when no activity)
periodicCall
+ bool periodicCall (const ewol::event::Time & _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)<br/>false No need to request the periodic call.
getPadding
+ ewol::Padding getPadding ();
get the padding declared by the user in the config file
Return: the padding property
getPaddingIn
+ ewol::Padding getPaddingIn ();
getPaddingOut
+ ewol::Padding getPaddingOut ();
getBorder
+ ewol::Padding getBorder ();
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 () const;
get the shaper file Source
Return: the shapper file name
hasSources
+ bool hasSources ();
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.
setShape
+ void setShape (const vec2 & _origin,
const vec2 & _size,
const vec2 & _insidePos,
const vec2 & _insideSize);
setShape
+ void setShape (const vec2 & _origin,
const vec2 & _size);
requestColor
+ int32_t requestColor (const std::string & _name);
Get an ID on the color instance element
Parameter [input]: _name Name of the element requested
Return: The Id of the color
getColor
+ const etk::Color<float> & getColor (int32_t _id);
Get The color associated at an ID.
Parameter [input]: _id Id of the color
Return: the reference on the color
requestConfig
+ int32_t requestConfig (const std::string & _name);
Get an ID on the configuration instance element
Parameter [input]: _name Name of the element requested
Return: The Id of the element
getConfigNumber
+ double getConfigNumber (int32_t _id);
Get The number associated at an ID.
Parameter [input]: _id Id of the parameter
Return: the requested number.
setActivateState
+ void setActivateState (int32_t _status);
Set activate state of the element
Parameter [input]: _status New activate status
operator ==
+ bool operator == (const Shaper & _obj) const;
operator !=
+ bool operator != (const Shaper & _obj) const;
+ewol::Compositing
+--> ewol::compositing::Shaper
Detail:
Shaper
+ Shaper (const std::string & _shaperName);generic constructor
| Parameter [input]: | _shaperName | Name of the file that might be loaded |
~Shaper
+ virtual ~Shaper ();generic destructor
draw
+ void draw (bool _disableDepthTest);draw All the refistered text in the current element on openGL
clear
+ void clear ();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)<br/>false No need to request the periodic call. |
getCurrentDisplayedStatus
+ int32_t getCurrentDisplayedStatus ();get the current displayed status of the shaper
| Return: | The Status Id |
getNextDisplayedStatus
+ int32_t getNextDisplayedStatus ();get the next displayed status of the shaper
| Return: | The next status Id (-1 if no status in next) |
getTransitionStatus
+ float getTransitionStatus ();get the current trasion status
| Return: | value of the transition status (0.0f when no activity) |
periodicCall
+ bool periodicCall (const ewol::event::Time & _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)<br/>false No need to request the periodic call. |
getPadding
+ ewol::Padding getPadding ();get the padding declared by the user in the config file
| Return: | the padding property |
getPaddingIn
+ ewol::Padding getPaddingIn ();
getPaddingOut
+ ewol::Padding getPaddingOut ();
getBorder
+ ewol::Padding getBorder ();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 () const;get the shaper file Source
| Return: | the shapper file name |
hasSources
+ bool hasSources ();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. |
setShape
+ void setShape (const vec2 & _origin,
const vec2 & _size,
const vec2 & _insidePos,
const vec2 & _insideSize);
setShape
+ void setShape (const vec2 & _origin,
const vec2 & _size);
requestColor
+ int32_t requestColor (const std::string & _name);Get an ID on the color instance element
| Parameter [input]: | _name | Name of the element requested |
| Return: | The Id of the color |
getColor
+ const etk::Color<float> & getColor (int32_t _id);Get The color associated at an ID.
| Parameter [input]: | _id | Id of the color |
| Return: | the reference on the color |
requestConfig
+ int32_t requestConfig (const std::string & _name);Get an ID on the configuration instance element
| Parameter [input]: | _name | Name of the element requested |
| Return: | The Id of the element |
getConfigNumber
+ double getConfigNumber (int32_t _id);Get The number associated at an ID.
| Parameter [input]: | _id | Id of the parameter |
| Return: | the requested number. |
setActivateState
+ void setActivateState (int32_t _status);Set activate state of the element
| Parameter [input]: | _status | New activate status |
operator ==
+ bool operator == (const Shaper & _obj) const;
operator !=
+ bool operator != (const Shaper & _obj) const;