All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Luminous::MultiHead::Area Class Reference

An OpenGL area. More...

#include <Luminous/MultiHead.hpp>

Inheritance diagram for Luminous::MultiHead::Area:
Valuable::Node Valuable::Attribute Patterns::NotCopyable Valuable::Serializable

Public Types

enum  RenderMethod { METHOD_TEXTURE_READBACK, METHOD_MATRIX_TRICK }
 How the area is rendered to the framebuffer. More...
 
- Public Types inherited from Valuable::Node
typedef container::const_iterator const_iterator
 
typedef Radiant::ArrayMap
< QByteArray, Attribute * > 
container
 Container for attributes, key is the attribute name.
 
typedef container::iterator iterator
 Iterator for the container.
 
typedef std::function< void(Radiant::BinaryData &)> ListenerFuncBd
 Listener function type that takes a BinaryData reference as a parameter, similar to eventProcess.
 
typedef std::function< void()> ListenerFuncVoid
 Default listener function type.
 
enum  ListenerType { DIRECT =1, AFTER_UPDATE =2, AFTER_UPDATE_ONCE =4 }
 Types of event listeners. More...
 
typedef int64_t Uuid
 Unique identifier type.
 
- Public Types inherited from Valuable::Attribute
enum  Layer {
  DEFAULT = 0, STYLE, USER, STYLE_IMPORTANT,
  LAYER_COUNT, LAYER_CURRENT
}
 Attribute has multiple independent attribute values on LAYER_COUNT different layers. More...
 
typedef std::function< void()> ListenerFunc
 Callback function type in the listener API.
 
enum  ListenerRole { DELETE_ROLE = 1 << 0, CHANGE_ROLE = 1 << 1, ALL_ROLES = (CHANGE_ROLE << 1) -1 }
 Different listener roles, used when adding a new listener.
 
enum  ValueUnit {
  VU_UNKNOWN, VU_PXS, VU_PERCENTAGE, VU_EMS,
  VU_EXS
}
 Units of a value. More...
 

Valuable Attributes

Nimble::Vector2f graphicslocation = Nimble::Vector2f(0, 0)
  More...
 
Nimble::SizeF graphicssize = Nimble::Vector2f(100, 100)
  More...
 
Vector2i location = Nimble::Vector2i(0, 0)
 Location of the area origin in pixels in window coordinates. More...
 
Nimble::Vector4f seams = Nimble::Vector4f(0, 0, 0, 0)
 Area seams are used by projector setups to define regions that are edge-blended together. More...
 
- Valuable Attributes inherited from Valuable::Node
Node::Uuid id = generateId()
 Returns the unique id. More...
 

Public Member Functions

 Area ()
 Constructs a new area for the given window.
 
ColorCorrectioncolorCorrection ()
 Get the 2D color-correction associated with this area. More...
 
const ColorCorrectioncolorCorrection () const
 Get the 2D color-correction associated with this area. More...
 
virtual bool deserialize (const Valuable::ArchiveElement &element)
 Deserializes this area from an archive element.
 
const Rect & graphicsBounds () const
 The bounds of the graphics. More...
 
const Nimble::Vector2f graphicsLocation (bool withseams=true) const
 Origin of the graphics coordinates in the area. More...
 
const Nimble::SizeF graphicsSize (bool withseams=true) const
 The size of the graphics inside this area (virtual pixels) More...
 
Nimble::Vector2f graphicsToWindow (Nimble::Vector2f loc, int windowheight, bool &insideArea) const
 Convert graphics coordinates to window coordinates. More...
 
GLKeyStonekeyStone ()
 Returns the keystone correction object. More...
 
const GLKeyStonekeyStone () const
 Returns the keystone correction object. More...
 
const Vector2i & location () const
 Location of the area origin in pixels in window coordinates.
 
float maxSeam () const
 Returns the width of the largest seam.
 
bool readElement (const Valuable::ArchiveElement &element)
 Handles a serialization element that lacks automatic handlers. More...
 
RGBCubergbCube ()
 Get the 3D color-correction RGB cube associated with this area. More...
 
const RGBCubergbCube () const
 Get the 3D color-correction RGB cube associated with this area. More...
 
Nimble::Vector4f seams () const
 Area seams are used by projector setups to define regions that are edge-blended together. More...
 
void setGeometry (int x, int y, int w, int h, bool copyToGraphics=true)
 Sets the geometry (size & offset) of the area. More...
 
void setGraphicsGeometry (int x, int y, int w, int h)
 Sets the graphics geometry of the area. More...
 
void setGraphicsLocation (Nimble::Vector2f l)
 
void setGraphicsSize (Nimble::SizeF size)
 
void setLocation (Nimble::Vector2i loc)
 Setter for attribute location. More...
 
void setSeams (Nimble::Vector4f seams)
 
void setSize (Nimble::Size size)
 
Nimble::Size size () const
 Size of the area inside the window in pixels.
 
void swapGraphicsWidthHeight ()
 Swaps the width and height of the graphics size.
 
QByteArray type () const
 Element type used for serialization. More...
 
Nimble::Recti viewport () const
 Get the viewport defined by the area in window coordinates. More...
 
Nimble::Matrix4 viewTransform () const
 Get the view transformation (projection) matrix defined by the area. More...
 
Nimble::Vector2f windowToGraphics (Nimble::Vector2f loc, int windowheight, bool &insideArea) const
 Convert window coordinates to graphics coordinates. More...
 
- Public Member Functions inherited from Valuable::Node
bool acceptsEvent (const QByteArray &messageId) const
 Returns true if this object accepts event 'id' in eventProcess.
 
bool addAttribute (Attribute *const attribute)
 Adds a new Attribute to the list of attribute objects. More...
 
bool addAttribute (const QByteArray &name, Attribute *const attribute)
 Adds a new Attribute to the list of attribute objects.
 
template<typename Widget >
bool addAttribute (const QByteArray &name, const Radiant::IntrusivePtr< Widget > &attribute)
 Adds a new Attribute to the list of attribute objects. More...
 
long addListener (const QByteArray &attribute, v8::Persistent< v8::Function > func, int role=Attribute::CHANGE_ROLE)
 Add a JavaScript attribute listener to attribute belonging this Node. More...
 
virtual Attributeattribute (const QByteArray &name) const
 Gets an Attribute with the given name. More...
 
template<typename T >
AttributeT< T > * attribute (const QByteArray &name) const
 Gets an Attribute with the given name. More...
 
const containerattributes () const
 
void clearValues (Layer layer)
 Clears all Attribute values of the given layer. More...
 
void debugDump ()
 Prints the contents of this Attribute to the terminal.
 
void eventAddDeprecated (const QByteArray &deprecatedId, const QByteArray &newId)
 Register a deprecated event that is automatically converted to new event id and a warning is issued when it is used. More...
 
void eventAddIn (const QByteArray &messageId)
 Registers a new event that this class handles in eventProcess.
 
template<typename Widget >
long eventAddListener (const QByteArray &eventId, const QByteArray &messageId, Radiant::IntrusivePtr< Widget > &listener, ListenerType listenerType=DIRECT, const Radiant::BinaryData *defaultData=0)
 Add an event listener to this object. More...
 
long eventAddListener (const QByteArray &eventId, const QByteArray &messageId, Valuable::Node *listener, ListenerType listenerType=DIRECT, const Radiant::BinaryData *defaultData=0)
 Add an event listener to this object. More...
 
long eventAddListener (const QByteArray &eventId, ListenerFuncVoid func, ListenerType listenerType=DIRECT)
 Add an event listener to this object. More...
 
long eventAddListener (const QByteArray &eventId, Node *dstNode, ListenerFuncVoid func, ListenerType listenerType=DIRECT)
 
long eventAddListenerBd (const QByteArray &eventId, Node *dstNode, ListenerFuncBd func, ListenerType listenerType=DIRECT)
 
long eventAddListenerBd (const QByteArray &eventId, ListenerFuncBd func, ListenerType listenerType=DIRECT)
 Add an event listener to this object. More...
 
void eventAddOut (const QByteArray &eventId)
 Registers a new event this class can send with eventSend.
 
const QSet< QByteArray > & eventInNames () const
 Returns set of all registered IN events.
 
unsigned eventListenerCount () const
 Returns the number of event listeners.
 
const QSet< QByteArray > & eventOutNames () const
 Returns set of all registered OUT events.
 
void eventPassingEnable (bool enable)
 Control whether events are passed.
 
template<typename Widget >
int eventRemoveListener (Radiant::IntrusivePtr< Widget > &listener)
 Removes all events from this object to given listener. More...
 
template<typename Widget >
int eventRemoveListener (const QByteArray &eventId=QByteArray(), const QByteArray &messageId=QByteArray(), Radiant::IntrusivePtr< Widget > &listener=Radiant::IntrusivePtr< Widget >())
 Removes events from this object that match the parameters. More...
 
int eventRemoveListener (const QByteArray &eventId=QByteArray(), const QByteArray &messageId=QByteArray(), Valuable::Node *listener=0)
 Removes event listeners from this object. More...
 
int eventRemoveListener (Valuable::Node *listener)
 Removes all events from this object to given listener. More...
 
bool eventRemoveListener (long listenerId)
 Removes event listener with given id. More...
 
void eventSend (const QByteArray &eventId, Radiant::BinaryData &bd)
 Sends an event and bd to all listeners on this eventId.
 
void eventSend (const QByteArray &eventId)
 Sends an event to all listeners on this eventId.
 
template<typename P1 >
void eventSend (const QByteArray &eventId, const P1 &p1)
 Sends an event to all listeners on this eventId. More...
 
template<typename P1 , typename P2 >
void eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2)
 Sends an event to all listeners on this eventId. More...
 
template<typename P1 , typename P2 , typename P3 >
void eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3)
 Sends an event to all listeners on this eventId. More...
 
template<typename P1 , typename P2 , typename P3 , typename P4 >
void eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3, const P4 &p4)
 Sends an event to all listeners on this eventId. More...
 
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 >
void eventSend (const QByteArray &eventId, const P1 &p1, const P2 &p2, const P3 &p3, const P4 &p4, const P5 &p5)
 Sends an event to all listeners on this eventId. More...
 
unsigned eventSourceCount () const
 Returns the number of event sources.
 
Uuid id () const
 Returns the unique id.
 
bool isBeingDestroyed () const
 Returns true if we are about to delete this object. More...
 
bool loadFromFileXML (const QString &filename)
 Reads this object (and its children) from an XML file.
 
bool loadFromMemoryXML (const QByteArray &buffer)
 Reads this object (and its children) from a memory buffer.
 
 Node (Node *host, const QByteArray &name="", bool transit=false)
 Constructs a new Node and adds it under the given host. More...
 
 Node (Node &&node)
 Moves a node, including all its attributes, events etc. More...
 
Nodeoperator= (Node &&node)
 Moves a node, replacing this. More...
 
void removeAttribute (Attribute *const attribute)
 Removes an Attribute from the list of attribute objects.
 
bool saveToFileXML (const QString &filename, unsigned int opts=SerializationOptions::DEFAULTS) const
 Saves this object (and its children) to an XML file.
 
bool saveToMemoryXML (QByteArray &buffer, unsigned int opts=SerializationOptions::DEFAULTS) const
 Saves this object (and its children) to binary data buffer.
 
virtual ArchiveElement serialize (Archive &doc) const
 Serializes this object (and its children) to a DOM node.
 
virtual void setAsDefaults ()
 Sets the current USER attribute value as the default value and clears the USER value. More...
 
void setId (Uuid newId)
 Sets the unique id. More...
 
template<class T >
bool setValue (const QByteArray &name, const T &v)
 Uses a query string to find a Attribute, and sets a new value to that if found. More...
 
bool setValue (const QByteArray &name, v8::Handle< v8::Value > v)
 Set attribute value from JavaScript. More...
 
- Public Member Functions inherited from Valuable::Attribute
long addListener (ListenerFunc func, int role=CHANGE_ROLE)
 Adds a listener that is invoked whenever the value is changed. More...
 
long addListener (Node *listener, ListenerFunc func, int role=CHANGE_ROLE)
 Adds a listener that is invoked whenever the value is changed. More...
 
long addListener (v8::Persistent< v8::Function > func, int role=CHANGE_ROLE)
 Adds a JavaScript listener that is invoked whenever the value is changed. More...
 
virtual float asFloat (bool *const ok=0, Layer layer=LAYER_CURRENT) const
 Converts the value object in a floating point number. More...
 
virtual int asInt (bool *const ok=0, Layer layer=LAYER_CURRENT) const
 Converts the value object in an integer. More...
 
virtual QString asString (bool *const ok=0, Layer layer=LAYER_CURRENT) const
 Converts the value object to a string. More...
 
 Attribute (const Attribute &o)
 Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...
 
 Attribute (Node *host, const QByteArray &name, bool transit=false)
 Constructs a new value object and attaches it to its host. More...
 
virtual void clearValue (Layer layer)
 Unsets the value from a specific layer. More...
 
virtual void emitChange ()
 Invokes the change valueChanged function of all listeners.
 
virtual void eventProcess (const QByteArray &id, Radiant::BinaryData &data)
 Process a message. More...
 
void eventProcessFloat (const char *id, float v)
 Utility function for sending a float message to the object.
 
void eventProcessInt (const char *id, int v)
 Utility function for sending an int message to the object.
 
void eventProcessString (const char *id, const QString &str)
 Utility function for sending string message to the object.
 
void eventProcessString (const char *id, const char *str)
 Utility function for sending string message to the object.
 
void eventProcessVector2 (const char *id, Nimble::Vector2)
 Utility function for sending a Nimble::Vector2f message to the object.
 
void eventProcessVector3 (const char *id, Nimble::Vector3)
 Utility function for sending a Vector3 message to the object.
 
void eventProcessVector4 (const char *id, Nimble::Vector4)
 Utility function for sending a Vector4 message to the object.
 
virtual bool handleShorthand (const Valuable::StyleValue &value, Radiant::ArrayMap< Valuable::Attribute *, Valuable::StyleValue > &expanded)
 If attribute supports shorthand properties, this should be used to parse those. More...
 
Nodehost () const
 The host object of the value object (is any). More...
 
virtual bool isChanged () const
 
virtual bool isValueDefinedOnLayer (Layer layer) const
 Check if the given layer defines a value. More...
 
bool layerForSerialization (SerializationOptions flags, Layer &layer) const
 
const QByteArray & name () const
 Returns the name of the object.
 
const Attributeoperator= (const Attribute &)
 Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...
 
AttributeownerShorthand () const
 
QByteArray path () const
 Returns the path (separated by '/'s) from the root.
 
void removeHost ()
 Sets the host pointer to zero and removes this object from the host. More...
 
bool removeListener (Node *listener, int role=ALL_ROLES)
 Removes a listener from the listener list. More...
 
bool removeListener (long id)
 Removes a listener from the listener list. More...
 
void removeListeners (int role=ALL_ROLES)
 Removes listeners from the listener list.
 
virtual bool set (float v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
 Sets the value of the object.
 
virtual bool set (int v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
 Sets the value of the object.
 
virtual bool set (const QString &v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector2f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector3f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector4f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual bool set (const StyleValue &value, Layer layer=USER)
 Sets the value of the object.
 
void setName (const QByteArray &s)
 Sets the name of the object.
 
void setOwnerShorthand (Attribute *owner)
 
- Public Member Functions inherited from Valuable::Serializable
virtual bool deserializeXML (const DOMElement &element)
 Deserializes (reads) this object from an XML element. More...
 
bool isSerializable () const
 
void setSerializable (bool v)
 

Additional Inherited Members

- Static Public Member Functions inherited from Valuable::Node
static bool copyValues (const Node &from, Node &to)
 Copies attribute values from one node to another. More...
 
static void disableQueue ()
 Disables all AFTER_UPDATE event processing, no new events will be accepted and the current queue will be cleared. More...
 
static Uuid generateId ()
 Generates a unique identifier. More...
 
static void invokeAfterUpdate (ListenerFuncVoid function)
 Queue function to be called in the main thread after the next update() More...
 
static int processQueue ()
 Triggers any pending AFTER_UPDATE-events. More...
 
static void reEnableQueue ()
 Enables queue after calling disableQueue. More...
 
static void setFatalOnEventMismatch (bool haltApplication)
 Controls what to do when an event mismatch is detected The default behavior is to output a warning to the terminal (haltApplication = false). More...
 
- Protected Member Functions inherited from Valuable::Node
virtual void attributeAdded (Attribute *attribute)
 This is called when new attribute is added to Node. More...
 
virtual void attributeRemoved (Attribute *attribute)
 This is called when attribute is removed from Node. More...
 
Nodesender ()
 Get the sender of the event, only valid in DIRECT events. More...
 
void setBeingDestroyed ()
 Sets 'isBeginDestroyed' flag to true and removes all event listeners to this object. More...
 

Detailed Description

An OpenGL area.

Areas are roughly equivalent to OpenGL viewports. Multiple areas can share the same OpenGL context, as one window can have may areas inside it.

Member Enumeration Documentation

How the area is rendered to the framebuffer.

Enumerator
METHOD_TEXTURE_READBACK 

Render to framebuffer, the read-back to texture, then re-render applying keystone-correction.

METHOD_MATRIX_TRICK 

Render to framebuffer using keystone-correction.

Member Function Documentation

ColorCorrection& Luminous::MultiHead::Area::colorCorrection ( )

Get the 2D color-correction associated with this area.

The 2D color-correction is used by the hardware on the cells.

Returns
2D color-correction
const ColorCorrection& Luminous::MultiHead::Area::colorCorrection ( ) const

Get the 2D color-correction associated with this area.

The 2D color-correction is used by the hardware on the cells.

Returns
2D color-correction
const Rect& Luminous::MultiHead::Area::graphicsBounds ( ) const

The bounds of the graphics.

In principle this method only combines the information you get with graphicsLocation() and graphicsSize(). In practice however that information is not exactly correct as the bounds also need to include the small extra areas, if edge-blending is used.

Returns
graphics bounds rectangle
const Nimble::Vector2f Luminous::MultiHead::Area::graphicsLocation ( bool  withseams = true) const

Origin of the graphics coordinates in the area.

Returns
Current value of the graphicslocation attribute
const Nimble::SizeF Luminous::MultiHead::Area::graphicsSize ( bool  withseams = true) const

The size of the graphics inside this area (virtual pixels)

Returns
Current value of the graphicssize attribute
Nimble::Vector2f Luminous::MultiHead::Area::graphicsToWindow ( Nimble::Vector2f  loc,
int  windowheight,
bool &  insideArea 
) const

Convert graphics coordinates to window coordinates.

Parameters
loclocation in graphics coordinates
windowheightheight of the window
[out]insideAreaset to true if the location is inside this area; otherwise false
Returns
vector in graphics coordinates.
GLKeyStone& Luminous::MultiHead::Area::keyStone ( )

Returns the keystone correction object.

Returns
keystone correction
const GLKeyStone& Luminous::MultiHead::Area::keyStone ( ) const

Returns the keystone correction object.

Returns
keystone correction
bool Luminous::MultiHead::Area::readElement ( const Valuable::ArchiveElement element)
virtual

Handles a serialization element that lacks automatic handlers.

Parameters
elementThe element to be deserialized
Returns
true on success

Reimplemented from Valuable::Node.

RGBCube& Luminous::MultiHead::Area::rgbCube ( )

Get the 3D color-correction RGB cube associated with this area.

The 3D color-correction is used by Cornerstone.

Returns
3D color-correction
const RGBCube& Luminous::MultiHead::Area::rgbCube ( ) const

Get the 3D color-correction RGB cube associated with this area.

The 3D color-correction is used by Cornerstone.

Returns
3D color-correction
Nimble::Vector4f Luminous::MultiHead::Area::seams ( ) const

Area seams are used by projector setups to define regions that are edge-blended together.

void Luminous::MultiHead::Area::setGeometry ( int  x,
int  y,
int  w,
int  h,
bool  copyToGraphics = true 
)

Sets the geometry (size & offset) of the area.

Parameters
xx offset
yy offset
wwidth
hheight
copyToGraphicsif true, the settings are copied to graphics coordinates
void Luminous::MultiHead::Area::setGraphicsGeometry ( int  x,
int  y,
int  w,
int  h 
)

Sets the graphics geometry of the area.

Parameters
xx coordinate of the graphics area
yy coordinate of the graphics area
wwidth of the graphics area
hheight of the graphics area
void Luminous::MultiHead::Area::setLocation ( Nimble::Vector2i  loc)

Setter for attribute location.

Parameters
locnew attribute value
QByteArray Luminous::MultiHead::Area::type ( ) const
inlinevirtual

Element type used for serialization.

Returns
"area"

Reimplemented from Valuable::Attribute.

Nimble::Recti Luminous::MultiHead::Area::viewport ( ) const

Get the viewport defined by the area in window coordinates.

Returns
the viewport defined by the area
Nimble::Matrix4 Luminous::MultiHead::Area::viewTransform ( ) const

Get the view transformation (projection) matrix defined by the area.

Returns
view transformation defined by the area
Nimble::Vector2f Luminous::MultiHead::Area::windowToGraphics ( Nimble::Vector2f  loc,
int  windowheight,
bool &  insideArea 
) const

Convert window coordinates to graphics coordinates.

Parameters
loclocation in window coordinates
windowheightheight of the window
[out]insideAreaset to true if the location is inside this area; otherwise false
Returns
vector in graphics coordinates.