SurfaceWidget Class Reference

#include <SurfaceWidget.h>

Inheritance diagram for SurfaceWidget:

List of all members.

Detailed Description

SurfaceWidget, fully constrained to 4 points.

Be sure that your concrete implementation checks if the gutz::RenderEvent is in pick mode, gutz::RenderEvent::picking(). This is important if you are rendering an "invisible" plane that can be selected, you need to make it visible while picking is happening.

     drawDef(const gutz::RenderEvent &re)
     {
        if(re.picking())
           drawThePlane(...);
        else
           /// maybe do nothing if invisible
     }

You can also optimize the pick procedure, by turning off complicated shaders and stuff, since it isn't a visible render pass when picking; you only need to render the surface of the plane.

Definition at line 45 of file SurfaceWidget.h.

Event & constraint mapper.

All widgets have the default event of: gutz::GUTZ_LEFT_MOUSE -> MOVE you may want to nuke this event if it isn't applicable: delEvent(gutz::GUTZ_LEFT_MOUSE); event keys are defined in: gutzKeyMouse.h

enum WIGET_BEHAVIORS { NO_EVENT = 0, MOVE, ROTATE, WB_LAST }

void addEvent (const unsigned int key, const unsigned int event, const ConstraintSP cnst=new Constraint())

addEvent. constraint defaults to "Free Move" constraint

unsigned int getEvent (const gutz::MouseEvent &me) const

getEvent, returns the event if one is defined, returns NO_EVENT if the mouse is up works for both: gutz::MouseEvent and gutz::MouseMoveEvent This function is usefull in implementation, externally use getEvent(unsigned int).

unsigned int getEvent (unsigned int key) const

what is the event assigned to a key

void delEvent (const unsigned int key)

delete an event from the event map

void nukeEvents ()

delete all events from the event map

gutz::EventKeyMap getEvents () const

void setEvents (const gutz::EventKeyMap &eventMap)

ConstraintMap getConstraints () const

void setConstraints (const ConstraintMap &cnstMap)

Clones

WidgetItem * clone () const

WidgetItem::clone definition.

virtual SurfaceWidget * cloneSurface () const=0

Pure virtual cloneSurface(), must be defined in (all) concrete SurfaceWidget classes.

set/get Points

gutz::vec3f getPoint (int ptIdx) const

void setPoint (int ptIdx, const gutz::vec3f &pt)

gutz::planef getPlane () const

get the plane that defines the surface, see gutz::plane

set specific points (slots):

void setLL (const gutz::vec3f &ll)

void setLR (const gutz::vec3f &lr)

void setUL (const gutz::vec3f &ul)

void setUR (const gutz::vec3f &ur)

Transform Widget

virtual void applyXform (gutz::mat4f xf)

apply a 4x4 transformation matrix, must be defined by a sub-class.

Behaviors from WidgetItem

virtual bool mouseDef (const gutz::MouseEvent &me)

override this one to implement mouse behavior

virtual bool moveDef (const gutz::MouseMoveEvent &mme)

override this one to implement move behavior

Events duplicated from <Renderable>.

These are duplicated to insure/ease framework issues, notice that mouse and move handle the "check with parent" and mouseDef(), moveDef() are what actually implement the behavior.

void draw (const gutz::RenderEvent &r)

main draw event...

virtual void drawDef (const gutz::RenderEvent &r)=0

PURE VIRTUAL draw defintion, must be implemented by concrete base class, be sure to apply the matrix associated with this widget (_mat).

bool mouse (const gutz::MouseEvent &me)

a mouse event...

virtual bool mouseChild (WidgetItem *child, const gutz::MouseEvent &me)

a child was moused, called before their mouseDef.

bool move (const gutz::MouseMoveEvent &mme)

a move event, checks with parent, then calls moveDef().

virtual bool moveChild (WidgetItem *child, const gutz::MouseMoveEvent &mme)

a child wants to be moved.

Parent/Child management

virtual void addChild (WidgetItem *child)

a child was added

virtual void delChild (WidgetItem *child)

a child was deleted/ changed parent

virtual void setParent (WidgetItem *parent)

a (new?) parent now owns you :)

Some appearance management

ColorWStateSP getColor () const

void setColor (ColorWState *const color)

Draw on/off.

bool isOn () const

void setOn (bool yes)

Delete.

Does this object need to be removed from a render list? This means that the object is finished and anyone with a smart pointer to it needs to delete the smart pointer and stop using the renderable.

bool needsDelete () const

void setDelete (bool yes)

Interaction Functions

Return true if the event was for you.
By default interaction is forwarded to your protected manipulator (_manip). To use it just apply it in your draw function. However, if you don't add any events or call setManipEventsDefault(), you won't have any interaction. Override these functions in your base class to implement custom behaviors.

virtual bool key (unsigned char k, int x, int y)

Selected

Is this object currently selected?

virtual void setSelected (bool yes)

bool isSelected () const

Manipulator Interface

gutz::Manip * getManip () const

void setManip (gutz::Manip *const m)

void setManipEventsDefault ()

you have to call this to enable default interaction, OR customize the manipulators events yourself.

Signals

gutz::Signal< int, const gutz::vec3f & > pointChanged

pointChanged(int,vec3f), point index & the point itself

gutz::Signal< const gutz::vec3f & > surfacePicked

signal: surfacePicked(const vec3f &pt);

gutz::Signal< const gutz::vec3f & > surfacePickMoved

signal: surfacePickMoved(const vec3f &)

Public Types

enum SURFACE_W_BEHAVIORS { PICK = WB_LAST + 1, SW_LAST }

enum SURFACE_POINTS {
LL, LR, UL, UR,
NODE_LAST
}

points corresponding to a frame (4point) surface More...

typedef gutz::SmartPtr< WidgetItem > WidgetItemSP

typedef gutz::vec2f Point2

2D point

typedef gutz::arrayOwn1< Point2 > Point2Array

2D point array

typedef gutz::vec3f Point3

3D point

typedef gutz::arrayOwn1< Point3 > Point3Array

3D point array

Public Member Functions

SurfaceWidget (WidgetItem *parent, float border=0, bool drawBorder=false)

virtual ~SurfaceWidget ()

virtual void setChanged ()

object changed

SurfaceWidget & operator= (const SurfaceWidget &sw)

assignment operator, just copys position information

virtual Point2Array getValidArea () const

get the "tightest 2D bounding polygon" in screen space

Public Attributes

HAS_SLOTS

Protected Member Functions

gutz::vec3f intersectPlane (const gutz::MouseEvent &me) const

SurfaceWidget (const SurfaceWidget &sw)

Copy does not copy/clone content, you need to handle that yourself.

virtual void _invalidate ()

called before widget changes, see also _update() some window systems need these calls before and after something changes, respectively, you'll have to specify them in your concrete class, if you need them.

virtual void _update ()

called after widget is changed

virtual void appearanceChanged ()

called if something about how it looks changes, does not include changes to the transform, just things like radius and color.

virtual void _incCount ()

gutz::Counted interface, increment reference count by one.

virtual void _decCount ()

gutz::Counted interface, decrement reference count by one.

virtual int _getCount () const

gutz::Counted interface, get the current reference count.

Protected Attributes

gutz::vec3f _corners [NODE_LAST]

These points are in LOCAL space.

gutz::vec3f _lastPick

This point is in WORLD space!!

bool _on

is this renderable currently "render-able"?

bool _selected

is this renderable selected?

bool _deleteMe

does this object need to be deleted?

gutz::ManipSP _manip

You get a manipulator free, no charge.

Friends

class SmartPtr

class SmartPtrRef

Member Typedef Documentation

typedef gutz::vec2f WidgetItem::Point2 [inherited]

2D point

Definition at line 124 of file WidgetBase.h.
Referenced by WidgetItem::getValidArea(), NodeWidget::getValidArea(), and EdgeWidget::getValidArea().

typedef gutz::arrayOwn1<Point2> WidgetItem::Point2Array [inherited]

2D point array

Definition at line 125 of file WidgetBase.h.
Referenced by WidgetItem::getValidArea(), NodeWidget::getValidArea(), and EdgeWidget::getValidArea().

typedef gutz::vec3f WidgetItem::Point3 [inherited]

3D point

Definition at line 127 of file WidgetBase.h.
Referenced by FrameWidget::setDims(), FrameWidget::setHeight(), and FrameWidget::setWidth().

typedef gutz::arrayOwn1<Point3> WidgetItem::Point3Array [inherited]

3D point array

Definition at line 128 of file WidgetBase.h.

typedef gutz::SmartPtr<WidgetItem> WidgetItem::WidgetItemSP [inherited]

Definition at line 122 of file WidgetBase.h.

Member Enumeration Documentation

enum SurfaceWidget::SURFACE_POINTS

points corresponding to a frame (4point) surface

Enumeration values:

LL Lower Left.

LR Lower Right.

UL Upper Left.

UR Upper Right.

NODE_LAST also the number of points/nodes

Definition at line 86 of file SurfaceWidget.h.

enum SurfaceWidget::SURFACE_W_BEHAVIORS

Enumeration values:

PICK only behavior defined is pick (default left mouse)

SW_LAST

Definition at line 48 of file SurfaceWidget.h.

enum WidgetItem::WIGET_BEHAVIORS [inherited]

Enumeration values:

NO_EVENT widget does nothing (by itself, but maybe parent does)

MOVE move according to world space deltas (default left mouse)

ROTATE rotate around center of widget

WB_LAST sub classes add events starting here (not an event)

Definition at line 313 of file WidgetBase.h.

Constructor & Destructor Documentation

SurfaceWidget::SurfaceWidget ( WidgetItem * parent,

float border = 0,

bool drawBorder = false

)

Definition at line 30 of file SurfaceWidget.cpp.
References WidgetItem::addEvent(), gutz::GUTZ_LEFT_MOUSE, PICK, and gutz::vec3f_zero.

virtual SurfaceWidget::~SurfaceWidget ( ) [inline, virtual]

Definition at line 54 of file SurfaceWidget.h.

SurfaceWidget::SurfaceWidget ( const SurfaceWidget & sw ) [inline, protected]

Copy does not copy/clone content, you need to handle that yourself.
Do you need to copy signals too? There are a number of things that make copying content unique, resolve those outside this class.
Definition at line 167 of file SurfaceWidget.h.
References _corners, and NODE_LAST.

Member Function Documentation

virtual void gutz::Counted::_decCount ( ) [inline, protected, virtual, inherited]

gutz::Counted interface, decrement reference count by one.
Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr. Sometimes you need to call this though, see the documentation for gutz::SmartPtr
Definition at line 54 of file smartptr.h.
Referenced by TFImage::clear(), NrroImage::fBlendOverRGBA(), and Nrro::updateMinMax().

virtual int gutz::Counted::_getCount ( ) const [inline, protected, virtual, inherited]

gutz::Counted interface, get the current reference count.
Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr.
Definition at line 58 of file smartptr.h.

virtual void gutz::Counted::_incCount ( ) [inline, protected, virtual, inherited]

gutz::Counted interface, increment reference count by one.
Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr. Sometimes you need to call this though, see the documentation for gutz::SmartPtr
Definition at line 48 of file smartptr.h.
Referenced by TFImage::clear(), NrroImage::fBlendOverRGBA(), and Nrro::updateMinMax().

virtual void WidgetItem::_invalidate ( ) [inline, protected, virtual, inherited]

called before widget changes, see also _update() some window systems need these calls before and after something changes, respectively, you'll have to specify them in your concrete class, if you need them.
They are quite usefull, if you need to update when a widget changes, but you don't (nescessarily) care what changed
Definition at line 380 of file WidgetBase.h.
Referenced by FrameWidget::setCenter(), FrameWidget::setDims(), EdgeWidget::setEndPoint(), FrameWidget::setHeight(), setPoint(), NodeWidget::setPointLocal(), EdgeWidget::setStartPoint(), and FrameWidget::setWidth().

virtual void WidgetItem::_update ( ) [inline, protected, virtual, inherited]

called after widget is changed

Definition at line 383 of file WidgetBase.h.
Referenced by FrameWidget::setCenter(), FrameWidget::setDims(), EdgeWidget::setEndPoint(), FrameWidget::setHeight(), setPoint(), NodeWidget::setPointLocal(), EdgeWidget::setStartPoint(), and FrameWidget::setWidth().

virtual void WidgetItem::addChild ( WidgetItem * child ) [inline, virtual, inherited]

a child was added

Definition at line 278 of file WidgetBase.h.

void WidgetItem::addEvent ( const unsigned int key,

const unsigned int event,

const ConstraintSP cnst = new Constraint()

) [inline, inherited]

addEvent. constraint defaults to "Free Move" constraint

Definition at line 321 of file WidgetBase.h.
References _constraintMap, and _eventMap.
Referenced by SurfaceWidget(), and WidgetItem::WidgetItem().

virtual void WidgetItem::appearanceChanged ( ) [inline, protected, virtual, inherited]

called if something about how it looks changes, does not include changes to the transform, just things like radius and color.

Reimplemented in GLUNodeWidget, and GLUEdgeWidget.
Definition at line 387 of file WidgetBase.h.
Referenced by EdgeWidget::setEndPoint(), NodeWidget::setRad(), EdgeWidget::setRad(), and EdgeWidget::setStartPoint().

virtual void SurfaceWidget::applyXform ( gutz::mat4f xf ) [inline, virtual]

apply a 4x4 transformation matrix, must be defined by a sub-class.

Implements WidgetItem.
Definition at line 148 of file SurfaceWidget.h.
References _corners, and NODE_LAST.

WidgetItem* SurfaceWidget::clone ( void ) const [inline, virtual]

WidgetItem::clone definition.

Implements WidgetItem.
Definition at line 61 of file SurfaceWidget.h.
References cloneSurface().

virtual SurfaceWidget* SurfaceWidget::cloneSurface ( ) const [pure virtual]

Pure virtual cloneSurface(), must be defined in (all) concrete SurfaceWidget classes.

Implemented in TFSurfaceWidget, GLSurfaceWidget, and SurfaceContentWidget.
Referenced by clone().

virtual void WidgetItem::delChild ( WidgetItem * child ) [inline, virtual, inherited]

a child was deleted/ changed parent

Reimplemented in FrameWidget.
Definition at line 280 of file WidgetBase.h.

void WidgetItem::delEvent ( const unsigned int key ) [inline, inherited]

delete an event from the event map

Definition at line 344 of file WidgetBase.h.
References _constraintMap, and _eventMap.

void WidgetItem::draw ( const gutz::RenderEvent & r ) [inline, virtual, inherited]

main draw event...
Framework only, do not override, Might need to add functionality here later.

Implements Renderable.
Definition at line 209 of file WidgetBase.h.
References WidgetItem::drawDef(), and r.

virtual void WidgetItem::drawDef ( const gutz::RenderEvent & r ) [pure virtual, inherited]

PURE VIRTUAL draw defintion, must be implemented by concrete base class, be sure to apply the matrix associated with this widget (_mat).

Implemented in GLTFSurfaceWidget, TFViewWidget, GLSurfaceWidget, GLUNodeWidget, GLUEdgeWidget, FrameWidget, PolygonWidget, and SurfaceContentWidget.
Referenced by WidgetItem::draw().

ColorWStateSP WidgetItem::getColor ( ) const [inline, inherited]

Definition at line 366 of file WidgetBase.h.
References _color.

ConstraintMap WidgetItem::getConstraints ( ) const [inline, inherited]

Definition at line 357 of file WidgetBase.h.
References _constraintMap, and ConstraintMap.

unsigned int WidgetItem::getEvent ( unsigned int key ) const [inline, inherited]

what is the event assigned to a key

Definition at line 338 of file WidgetBase.h.
References _eventMap.

unsigned int WidgetItem::getEvent ( const gutz::MouseEvent & me ) const [inline, inherited]

getEvent, returns the event if one is defined, returns NO_EVENT if the mouse is up works for both: gutz::MouseEvent and gutz::MouseMoveEvent This function is usefull in implementation, externally use getEvent(unsigned int).

Definition at line 331 of file WidgetBase.h.
References _eventMap, gutz::MouseEvent::getButton(), gutz::MouseEvent::isButtonDown(), and WidgetItem::NO_EVENT.
Referenced by WidgetItem::mouseDef(), mouseDef(), and moveDef().

gutz::EventKeyMap WidgetItem::getEvents ( ) const [inline, inherited]

Definition at line 353 of file WidgetBase.h.
References _eventMap.

gutz::Manip* Renderable::getManip ( ) const [inline, inherited]

Definition at line 184 of file Renderable.h.
References Renderable::_manip.

gutz::planef SurfaceWidget::getPlane ( ) const [inline]

get the plane that defines the surface, see gutz::plane

Definition at line 111 of file SurfaceWidget.h.
References getPoint(), LL, LR, gutz::planef, and UL.
Referenced by GLTFSurfaceWidget::drawDef(), GLSurfaceWidget::drawQuad(), and intersectPlane().

gutz::vec3f SurfaceWidget::getPoint ( int ptIdx ) const [inline]

Definition at line 99 of file SurfaceWidget.h.
References _corners, and Renderable::_manip.
Referenced by getPlane(), operator=(), and setPoint().

virtual Point2Array WidgetItem::getValidArea ( ) const [inline, virtual, inherited]

get the "tightest 2D bounding polygon" in screen space

Reimplemented in EdgeWidget, and NodeWidget.
Definition at line 302 of file WidgetBase.h.
References WidgetItem::Point2, and WidgetItem::Point2Array.

gutz::vec3f SurfaceWidget::intersectPlane ( const gutz::MouseEvent & me ) const [protected]

Definition at line 39 of file SurfaceWidget.cpp.
References Renderable::_manip, getPlane(), gutz::MouseEvent::getWorldPos(), gutz::planef, t, and gutz::vec3f.
Referenced by mouseDef(), and moveDef().

bool Renderable::isOn ( ) const [inline, inherited]

Definition at line 141 of file Renderable.h.
References Renderable::_on.

bool Renderable::isSelected ( ) const [inline, inherited]

Definition at line 177 of file Renderable.h.
References Renderable::_selected.

virtual bool Renderable::key ( unsigned char k,

int x,

int y

) [inline, virtual, inherited]

Definition at line 166 of file Renderable.h.

bool WidgetItem::mouse ( const gutz::MouseEvent & me ) [inline, virtual, inherited]

a mouse event...
checks with parent, then calls mouseDef()
Framework only, do not override.
Reimplemented from Renderable.
Definition at line 220 of file WidgetBase.h.
References WidgetItem::mouseDef().

virtual bool WidgetItem::mouseChild ( WidgetItem * child,

const gutz::MouseEvent & me

) [inline, virtual, inherited]

a child was moused, called before their mouseDef.
return true if & only if parent will be handling the mouse event
return false if the child handles it's own mouse event

Reimplemented in TFViewWidget, FrameWidget, and SurfaceContentWidget.
Definition at line 238 of file WidgetBase.h.

bool SurfaceWidget::mouseDef ( const gutz::MouseEvent & me ) [virtual]

override this one to implement mouse behavior

Reimplemented from WidgetItem.
Definition at line 53 of file SurfaceWidget.cpp.
References _lastPick, WidgetItem::getEvent(), intersectPlane(), WidgetItem::NO_EVENT, and surfacePicked.

bool WidgetItem::move ( const gutz::MouseMoveEvent & mme ) [inline, virtual, inherited]

a move event, checks with parent, then calls moveDef().
Framework only, do not override.
Reimplemented from Renderable.
Definition at line 245 of file WidgetBase.h.
References WidgetItem::moveDef().

virtual bool WidgetItem::moveChild ( WidgetItem * child,

const gutz::MouseMoveEvent & mme

) [inline, virtual, inherited]

a child wants to be moved.
if true, child does nothing (parent moves them) if false, child moves self
Reimplemented in TFViewWidget, FrameWidget, and SurfaceContentWidget.
Definition at line 267 of file WidgetBase.h.

bool SurfaceWidget::moveDef ( const gutz::MouseMoveEvent & mme ) [virtual]

override this one to implement move behavior

Reimplemented from WidgetItem.
Definition at line 71 of file SurfaceWidget.cpp.
References _lastPick, WidgetItem::getEvent(), intersectPlane(), WidgetItem::NO_EVENT, and surfacePickMoved.

bool Renderable::needsDelete ( ) const [inline, inherited]

Definition at line 152 of file Renderable.h.
References Renderable::_deleteMe.

void WidgetItem::nukeEvents ( ) [inline, inherited]

delete all events from the event map

Definition at line 347 of file WidgetBase.h.
References _constraintMap, _eventMap, and ConstraintMap.

SurfaceWidget& SurfaceWidget::operator= ( const SurfaceWidget & sw ) [inline]

assignment operator, just copys position information

Definition at line 79 of file SurfaceWidget.h.
References getPoint(), NODE_LAST, and setPoint().
Referenced by TFSurfaceWidget::operator=(), and GLSurfaceWidget::operator=().

virtual void SurfaceWidget::setChanged ( ) [inline, virtual]

object changed

Implements WidgetItem.
Reimplemented in SurfaceContentWidget.
Definition at line 72 of file SurfaceWidget.h.
References _corners, NODE_LAST, and pointChanged.
Referenced by SurfaceContentWidget::setChanged().

void WidgetItem::setColor ( ColorWState *const color ) [inline, inherited]

Definition at line 367 of file WidgetBase.h.
References _color.
Referenced by GLUEdgeWidget::GLUEdgeWidget(), and GLUNodeWidget::GLUNodeWidget().

void WidgetItem::setConstraints ( const ConstraintMap & cnstMap ) [inline, inherited]

Definition at line 358 of file WidgetBase.h.
References _constraintMap.

void Renderable::setDelete ( bool yes ) [inline, inherited]

Definition at line 153 of file Renderable.h.
References Renderable::_deleteMe, and Renderable::setOn().

void WidgetItem::setEvents ( const gutz::EventKeyMap & eventMap ) [inline, inherited]

Definition at line 354 of file WidgetBase.h.
References _eventMap.

void SurfaceWidget::setLL ( const gutz::vec3f & ll ) [inline]

Definition at line 122 of file SurfaceWidget.h.
References LL, and setPoint().
Referenced by FrameWidget::delSurface(), and FrameWidget::setSurface().

void SurfaceWidget::setLR ( const gutz::vec3f & lr ) [inline]

Definition at line 123 of file SurfaceWidget.h.
References LR, and setPoint().
Referenced by FrameWidget::delSurface(), and FrameWidget::setSurface().

void Renderable::setManip ( gutz::Manip *const m ) [inline, inherited]

Definition at line 185 of file Renderable.h.
References Renderable::_manip.

void Renderable::setManipEventsDefault ( ) [inline, inherited]

you have to call this to enable default interaction, OR customize the manipulators events yourself.

Definition at line 188 of file Renderable.h.
References Renderable::_manip.

void Renderable::setOn ( bool yes ) [inline, inherited]

Definition at line 142 of file Renderable.h.
References Renderable::_on.
Referenced by Renderable::setDelete().

virtual void WidgetItem::setParent ( WidgetItem * parent ) [inline, virtual, inherited]

a (new?) parent now owns you :)

Definition at line 283 of file WidgetBase.h.
References Renderable::_manip.
Referenced by SurfaceContentWidget::addContent(), SurfaceContentWidget::delContent(), and PolygonWidget::setPoints().

void SurfaceWidget::setPoint ( int ptIdx,

const gutz::vec3f & pt

) [inline]

Definition at line 101 of file SurfaceWidget.h.
References _corners, WidgetItem::_invalidate(), Renderable::_manip, WidgetItem::_update(), getPoint(), and pointChanged.
Referenced by operator=(), setLL(), setLR(), setUL(), and setUR().

virtual void Renderable::setSelected ( bool yes ) [inline, virtual, inherited]

Definition at line 176 of file Renderable.h.
References Renderable::_selected.

void SurfaceWidget::setUL ( const gutz::vec3f & ul ) [inline]

Definition at line 124 of file SurfaceWidget.h.
References setPoint(), and UL.
Referenced by FrameWidget::delSurface(), and FrameWidget::setSurface().

void SurfaceWidget::setUR ( const gutz::vec3f & ur ) [inline]

Definition at line 125 of file SurfaceWidget.h.
References setPoint(), and UR.
Referenced by FrameWidget::delSurface(), and FrameWidget::setSurface().

Friends And Related Function Documentation

friend class SmartPtr [friend, inherited]

Definition at line 40 of file smartptr.h.
Referenced by Nrro::NrroIter< T >::NrroIter().

friend class SmartPtrRef [friend, inherited]

Definition at line 41 of file smartptr.h.

Member Data Documentation

gutz::vec3f SurfaceWidget::_corners[NODE_LAST] [protected]

These points are in LOCAL space.

Definition at line 175 of file SurfaceWidget.h.
Referenced by applyXform(), GLTFSurfaceWidget::drawDef(), GLSurfaceWidget::drawQuad(), getPoint(), setChanged(), setPoint(), and SurfaceWidget().

bool Renderable::_deleteMe [protected, inherited]

does this object need to be deleted?

Definition at line 237 of file Renderable.h.
Referenced by Renderable::needsDelete(), Renderable::Renderable(), and Renderable::setDelete().

gutz::vec3f SurfaceWidget::_lastPick [protected]

This point is in WORLD space!!

Definition at line 178 of file SurfaceWidget.h.
Referenced by GLSurfaceWidget::drawQuad(), mouseDef(), and moveDef().

gutz::ManipSP Renderable::_manip [protected, inherited]

You get a manipulator free, no charge.

Definition at line 240 of file Renderable.h.
Referenced by FrameWidget::configureFrame(), GLUEdgeWidget::drawDef(), GLUNodeWidget::drawDef(), GLSurfaceWidget::drawQuad(), EdgeWidget::getEndPoint(), Renderable::getManip(), getPoint(), NodeWidget::getPoint(), NodeWidget::getPointLocal(), EdgeWidget::getStartPoint(), intersectPlane(), Renderable::mouse(), FrameWidget::mouseChild(), WidgetItem::mouseDef(), Renderable::move(), FrameWidget::moveChild(), WidgetItem::moveDef(), NodeWidget::NodeWidget(), Renderable::operator=(), Renderable::Renderable(), EdgeWidget::setEndPoint(), Renderable::setManip(), Renderable::setManipEventsDefault(), WidgetItem::setParent(), setPoint(), NodeWidget::setPoint(), NodeWidget::setPointLocal(), EdgeWidget::setStartPoint(), and FrameWidget::updateManip().

bool Renderable::_on [protected, inherited]

is this renderable currently "render-able"?

Definition at line 235 of file Renderable.h.
Referenced by Renderable::isOn(), Renderable::operator=(), Renderable::Renderable(), and Renderable::setOn().

bool Renderable::_selected [protected, inherited]

is this renderable selected?

Definition at line 236 of file Renderable.h.
Referenced by Renderable::isSelected(), Renderable::Renderable(), and Renderable::setSelected().

SurfaceWidget::HAS_SLOTS

Definition at line 94 of file SurfaceWidget.h.

gutz::Signal<int, const gutz::vec3f &> SurfaceWidget::pointChanged

pointChanged(int,vec3f), point index & the point itself

Definition at line 134 of file SurfaceWidget.h.
Referenced by setChanged(), and setPoint().

gutz::Signal<const gutz::vec3f &> SurfaceWidget::surfacePicked

signal: surfacePicked(const vec3f &pt);

Definition at line 137 of file SurfaceWidget.h.
Referenced by mouseDef().

gutz::Signal<const gutz::vec3f &> SurfaceWidget::surfacePickMoved

signal: surfacePickMoved(const vec3f &)

Definition at line 140 of file SurfaceWidget.h.
Referenced by moveDef().

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

Send questions, comments, and bug reports to:
jmk


Event & constraint mapper.
All widgets have the default event of: gutz::GUTZ_LEFT_MOUSE -> MOVE you may want to nuke this event if it isn't applicable: delEvent(gutz::GUTZ_LEFT_MOUSE); event keys are defined in: gutzKeyMouse.h
enum	WIGET_BEHAVIORS { NO_EVENT = 0, MOVE, ROTATE, WB_LAST }
void	addEvent (const unsigned int key, const unsigned int event, const ConstraintSP cnst=new Constraint())
	addEvent. constraint defaults to "Free Move" constraint
unsigned int	getEvent (const gutz::MouseEvent &me) const
	getEvent, returns the event if one is defined, returns NO_EVENT if the mouse is up works for both: gutz::MouseEvent and gutz::MouseMoveEvent This function is usefull in implementation, externally use getEvent(unsigned int).
unsigned int	getEvent (unsigned int key) const
	what is the event assigned to a key
void	delEvent (const unsigned int key)
	delete an event from the event map
void	nukeEvents ()
	delete all events from the event map
gutz::EventKeyMap	getEvents () const
void	setEvents (const gutz::EventKeyMap &eventMap)
ConstraintMap	getConstraints () const
void	setConstraints (const ConstraintMap &cnstMap)
Clones
WidgetItem *	clone () const
	WidgetItem::clone definition.
virtual SurfaceWidget *	cloneSurface () const=0
	Pure virtual cloneSurface(), must be defined in (all) concrete SurfaceWidget classes.
set/get Points
gutz::vec3f	getPoint (int ptIdx) const
void	setPoint (int ptIdx, const gutz::vec3f &pt)
gutz::planef	getPlane () const
	get the plane that defines the surface, see gutz::plane
set specific points (slots):
void	setLL (const gutz::vec3f &ll)
void	setLR (const gutz::vec3f &lr)
void	setUL (const gutz::vec3f &ul)
void	setUR (const gutz::vec3f &ur)
Transform Widget
virtual void	applyXform (gutz::mat4f xf)
	apply a 4x4 transformation matrix, must be defined by a sub-class.
Behaviors from WidgetItem
virtual bool	mouseDef (const gutz::MouseEvent &me)
	override this one to implement mouse behavior
virtual bool	moveDef (const gutz::MouseMoveEvent &mme)
	override this one to implement move behavior
Events duplicated from <Renderable>.
These are duplicated to insure/ease framework issues, notice that mouse and move handle the "check with parent" and mouseDef(), moveDef() are what actually implement the behavior.
void	draw (const gutz::RenderEvent &r)
	main draw event...
virtual void	drawDef (const gutz::RenderEvent &r)=0
	PURE VIRTUAL draw defintion, must be implemented by concrete base class, be sure to apply the matrix associated with this widget (_mat).
bool	mouse (const gutz::MouseEvent &me)
	a mouse event...
virtual bool	mouseChild (WidgetItem *child, const gutz::MouseEvent &me)
	a child was moused, called before their mouseDef.
bool	move (const gutz::MouseMoveEvent &mme)
	a move event, checks with parent, then calls moveDef().
virtual bool	moveChild (WidgetItem *child, const gutz::MouseMoveEvent &mme)
	a child wants to be moved.
Parent/Child management
virtual void	addChild (WidgetItem *child)
	a child was added
virtual void	delChild (WidgetItem *child)
	a child was deleted/ changed parent
virtual void	setParent (WidgetItem *parent)
	a (new?) parent now owns you :)
Some appearance management
ColorWStateSP	getColor () const
void	setColor (ColorWState *const color)
Draw on/off.
bool	isOn () const
void	setOn (bool yes)
Delete.
Does this object need to be removed from a render list? This means that the object is finished and anyone with a smart pointer to it needs to delete the smart pointer and stop using the renderable.
bool	needsDelete () const
void	setDelete (bool yes)
Interaction Functions
Return true if the event was for you. By default interaction is forwarded to your protected manipulator (_manip). To use it just apply it in your draw function. However, if you don't add any events or call setManipEventsDefault(), you won't have any interaction. Override these functions in your base class to implement custom behaviors.
virtual bool	key (unsigned char k, int x, int y)
Selected
Is this object currently selected?
virtual void	setSelected (bool yes)
bool	isSelected () const
Manipulator Interface
gutz::Manip *	getManip () const
void	setManip (gutz::Manip *const m)
void	setManipEventsDefault ()
	you have to call this to enable default interaction, OR customize the manipulators events yourself.
Signals
gutz::Signal< int, const gutz::vec3f & >	pointChanged
	pointChanged(int,vec3f), point index & the point itself
gutz::Signal< const gutz::vec3f & >	surfacePicked
	signal: surfacePicked(const vec3f &pt);
gutz::Signal< const gutz::vec3f & >	surfacePickMoved
	signal: surfacePickMoved(const vec3f &)
Public Types
enum	SURFACE_W_BEHAVIORS { PICK = WB_LAST + 1, SW_LAST }
enum	SURFACE_POINTS { LL, LR, UL, UR, NODE_LAST }
	points corresponding to a frame (4point) surface More...
typedef gutz::SmartPtr< WidgetItem >	WidgetItemSP
typedef gutz::vec2f	Point2
	2D point
typedef gutz::arrayOwn1< Point2 >	Point2Array
	2D point array
typedef gutz::vec3f	Point3
	3D point
typedef gutz::arrayOwn1< Point3 >	Point3Array
	3D point array
Public Member Functions
	SurfaceWidget (WidgetItem *parent, float border=0, bool drawBorder=false)
virtual	~SurfaceWidget ()
virtual void	setChanged ()
	object changed
SurfaceWidget &	operator= (const SurfaceWidget &sw)
	assignment operator, just copys position information
virtual Point2Array	getValidArea () const
	get the "tightest 2D bounding polygon" in screen space
Public Attributes
	HAS_SLOTS
Protected Member Functions
gutz::vec3f	intersectPlane (const gutz::MouseEvent &me) const
	SurfaceWidget (const SurfaceWidget &sw)
	Copy does not copy/clone content, you need to handle that yourself.
virtual void	_invalidate ()
	called before widget changes, see also _update() some window systems need these calls before and after something changes, respectively, you'll have to specify them in your concrete class, if you need them.
virtual void	_update ()
	called after widget is changed
virtual void	appearanceChanged ()
	called if something about how it looks changes, does not include changes to the transform, just things like radius and color.
virtual void	_incCount ()
	gutz::Counted interface, increment reference count by one.
virtual void	_decCount ()
	gutz::Counted interface, decrement reference count by one.
virtual int	_getCount () const
	gutz::Counted interface, get the current reference count.
Protected Attributes
gutz::vec3f	_corners [NODE_LAST]
	These points are in LOCAL space.
gutz::vec3f	_lastPick
	This point is in WORLD space!!
bool	_on
	is this renderable currently "render-able"?
bool	_selected
	is this renderable selected?
bool	_deleteMe
	does this object need to be deleted?
gutz::ManipSP	_manip
	You get a manipulator free, no charge.
Friends
class	SmartPtr
class	SmartPtrRef