User Documentation
Centre for Vision, Speech & Signal Processing
DEVELOP IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
Canvas3DC::Canvas3DC(void)
Canvas3DC::Canvas3DC(int,int,int *)
Canvas3DC::Canvas3DC(Canvas3DBodyC &)
Canvas3DC::GUISwapBuffers(void)
Canvas3DC::SwapBuffers(void)
Canvas3DC::ViewPoint(RealT,Point3dC,Point3dC,Vector3dC)
Canvas3DC::Light(const RGBPointC &,const Point3dC &,int)
Canvas3DC::Transform(RealT,const Vector3dC &)
Canvas3DC::Transform(RealT,const Vector3dC &,const Vector3dC &)
Canvas3DC::Transform(RealT,const Vector3dC &,const Vector3dC &,const DObject3DC &)
Canvas3DC::Transform(const Vector3dC &)
Canvas3DC::Transform(RealT,const Vector3dC &,const DObject3DC &)
Canvas3DC::Render(ScopePath (*)(FuncArgList))
Canvas3DC::Render(ScopePath (*)(FuncArgList),const DataT &)
Canvas3DC::Render(ScopePath (*)(FuncArgList),const Data1T &,const Data2T &)
Canvas3DC::Render(const ObjT &,ScopePath (*)(FuncArgList))
Canvas3DC::Render(const ObjT &,ScopePath (*)(FuncArgList),const DataT &)
Canvas3DC::Render(const ObjT &,ScopePath (*)(FuncArgList),const Data1T &,const Data2T &)
Canvas3DC::RenderRef(ObjT &,ScopePath (*)(FuncArgList))
Canvas3DC::RenderRef(ObjT &,ScopePath (*)(FuncArgList),const DataT &)
Canvas3DC::RenderRef(ObjT &,ScopePath (*)(FuncArgList),const Data1T &,const Data2T &)
DPOPortC::Put(const DataT &)
DPOPortC::PutArray(const SArray1dC &)
DPOPortC::IsPutReady(void) const
GUIWidgetC::Destroy(void)
GUIWidgetC::Widget(void)
GUIWidgetC::WidgetName(void) const
GUIWidgetC::Name(void) const
GUIWidgetC::WidgetID(void) const
GUIWidgetC::Service(void)
GUIWidgetC::Create(void)
GUIWidgetC::GUIShow(void)
GUIWidgetC::GUIHide(void)
GUIWidgetC::Show(void)
GUIWidgetC::Hide(void)
GUIWidgetC::Position(void) const
GUIWidgetC::Size(void) const
GUIWidgetC::GUISetUSize(IntT,IntT)
GUIWidgetC::SetState(GtkStateType)
GUIWidgetC::Rectangle(void) const
GUIWidgetC::operator+(const GUIWidgetC &) const
GUIWidgetC::Signal(const char *)
GUIWidgetC::SetToolTip(const char *,const char *)
GUIWidgetC::AddEventMask(IntT)
GUIWidgetC::DelEventMask(IntT)
GUIWidgetC::ShapeCombineMask(GdkBitmap &,int,int)
DPOPortBaseC::PutEOS(void)
DPOPortBaseC::OutputType(void) const
DPEntityC::operator=(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
DPEntityC::Save(ostream &) const
DPPortC::IsAsync(void) const
DPPortC::ConnectedTo(void) const
DPPortC::GetAttr(const StringC &,StringC &)
DPPortC::SetAttr(const StringC &,const StringC &)
RCHandleAC::Abstract(void)
RCHandleAC::IsHandleType(const DT &) const
RCHandleAC::CheckHandleType(const DT &) const
RCHandleAC::Save(ostream &) const
RCHandleAC::Copy(void) const
DPEntityC::operator=(const DPEntityC &)
DPEntityC::Body(void)
DPEntityC::Body(void) const
DPEntityC::Save(ostream &) const
RCHandleC::IsValid(void) const
RCHandleC::IsValidObject(void) const
RCHandleC::operator=(const RCHandleC &)
RCHandleC::operator==(const RCHandleC &) const
RCHandleC::operator!=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsConst(void) const
RCHandleC::IsNotConst(void) const
RCHandleC::SetConst(void) const
RCHandleC::Invalidate(void)
RCHandleC::Body(void)
RCHandleC::Body(void) const
Canvas3DC
 
3D Canvas Widget.
 
include "amma/GUI/3D/3DCanvas.hh"
User Level:Default
Library:GUI3D
Example:ex3DCanvas.cc
Section:GUI.3D
In Scope:std

Parent Classes:

Methods:
Canvas3DC()
Default constructor.
Creates an invalid handle.

Canvas3DC(int x,int y,int * nglattrlist = 0)
Constructor.
see GUI/3D/gdkgl.h for a list of attributes for nglattrlist, the attribute list should be terminated with GDK_GL_NONE.

Canvas3DC(Canvas3DBodyC & bod)
Body constructor

BooleanT GUISwapBuffers()
swap buffers.
NB. Only call from the GUI thread.

void SwapBuffers()
Swap display buffers.
Thread safe.

void ViewPoint(RealT fov = 90,Point3dC nEye = Point3dC(0,0,5),Point3dC nCentre = Point3dC(0,0,0),Vector3dC nUp = Vector3dC(0,1,0))
Set the view point.
Thread safe.

void Light(const RGBPointC & colour,const Point3dC & position,int nn = 0)
Setup a light nn.
Thread safe

void Transform(RealT nAngle,const Vector3dC & nAxis)
Rotation Constructor.

void Transform(RealT nAngle,const Vector3dC & nAxis,const Vector3dC & nTrans)
Rotation/Translation Constructor.

void Transform(RealT nAngle,const Vector3dC & nAxis,const Vector3dC & nTrans,const DObject3DC & obj)
Rotation/Translation Constructor.

void Transform(const Vector3dC & nTrans)
Translation Constructor.

void Transform(RealT nAngle,const Vector3dC & nAxis,const DObject3DC & obj)
Constructor.

void Render(ScopePath (*)(FuncArgList) nfunc)
Call OpenGL rendering function.

void Render(ScopePath (*)(FuncArgList) nfunc,const DataT & dat)
Call OpenGL rendering function.

void Render(ScopePath (*)(FuncArgList) nfunc,const Data1T & dat1,const Data2T & dat2)
Call OpenGL rendering function.

void Render(const ObjT & nobj,ScopePath (*)(FuncArgList) nfunc)
Call OpenGL rendering function.

void Render(const ObjT & nobj,ScopePath (*)(FuncArgList) nfunc,const DataT & dat)
Call OpenGL rendering function.

void Render(const ObjT & nobj,ScopePath (*)(FuncArgList) nfunc,const Data1T & dat1,const Data2T & dat2)
Call OpenGL rendering function.

void RenderRef(ObjT & nobj,ScopePath (*)(FuncArgList) nfunc)
Call OpenGL rendering function.
Use only a refrence to 'nobj', not a copy. NB. This means the refrence counter will NOT be incremented.

void RenderRef(ObjT & nobj,ScopePath (*)(FuncArgList) nfunc,const DataT & dat)
Call OpenGL rendering function.
Use only a refrence to 'nobj', not a copy. NB. This means the refrence counter will NOT be incremented.

void RenderRef(ObjT & nobj,ScopePath (*)(FuncArgList) nfunc,const Data1T & dat1,const Data2T & dat2)
Call OpenGL rendering function.
Use only a refrence to 'nobj', not a copy. NB. This means the refrence counter will NOT be incremented.

#include "amma/DP/Port.hh"
BooleanT Put(const DObject3DC & dat)
Put data to stream
Returns true if data is put into stream succesfully.

IntT PutArray(const SArray1dC<DObject3DC> & data)
Put an array of data elements into a stream.
returns the number of elements processed from the array.

BooleanT IsPutReady() const
Is port ready for data ?

#include "amma/GUI/Widget.hh"
void Destroy()
See body class for details.

GtkWidget * Widget()
Access widget.

StringC WidgetName() const
Get widget's name.
Call only from GUI thread.

StringC Name() const
Get name of widget.
Defaults to WidgetName(), but may be differnt for Lables etc.

int WidgetID() const
Get widget id.

BooleanT Service()
Service request.

BooleanT Create()
Create the widget.

void GUIShow()
Show widget on the display.
Call only from GUI thread.

void GUIHide()
Hide widget on the display.
Call only from GUI thread.

void Show()
Show widget on the display.
Thread safe.

void Hide()
Hide widget on the display.
Thread safe.

PixelC Position() const
Widget position.

PixelC Size() const
Size of wiget in pixels

void GUISetUSize(IntT x,IntT y)
Set size of widget.
GUI thread only.

void SetState(GtkStateType state)
Set state

IndexRectangleC Rectangle() const
Widget position and extent within its parent window.

DListC<GUIWidgetC> operator+(const GUIWidgetC & widge) const
Add into list.

Signal0C & Signal(const char * nm)
Get handle for named signal.
Signal is created and connected when this function is first called. There after the same signal is returned.

If the signal is unrecognised an invalid handle is returned.

The exact signal type depends on the signal requested, if not otherwise specified it is a Signal1C.


void SetToolTip(const char * text,const char * ctxt = 0)
Set the tool tip for the widget.
NB. Not all widgets can display tooltips.

void AddEventMask(IntT event)
Add to the event mask.

void DelEventMask(IntT event)
Remove from the event mask.

void ShapeCombineMask(GdkBitmap & mask,int off_x = 0,int off_y = 0)
Make a shape mask for the widget.
GUI thread only.

#include "amma/DP/Port.hh"
void PutEOS()
Put End Of Stream marker.

const type_info & OutputType() const
Get type of output port.

#include "amma/DP/Entity.hh"
const DPEntityC & operator=(const DPEntityC & dat)
Assignment.

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

BooleanT Save(ostream & out) const

#include "amma/DP/Port.hh"
BooleanT IsAsync() const
Does port work asynchronously ??

DPPortC ConnectedTo() const
Is this port connected to another ?
If not returns invalid handle.

BooleanT GetAttr(const StringC & attrName,StringC & attrValue)
Get a stream attribute.
Returns false if the attribute name is unknown. This is for handling stream attributes such as frame rate, and compression ratios.

BooleanT SetAttr(const StringC & attrName,const StringC & attrValue)
Set a stream attribute.
Returns false if the attribute name is unknown. This is for handling stream attributes such as frame rate, and compression ratios.

#include "amma/RCHandleA.hh"
RCAbstractC Abstract()
Create an abstract handle to this object.

BooleanT IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

BooleanT Save(ostream & out) const
Save to ostream.

RCHandleAC<DPEntityBodyC> Copy() const
Creat a deep copy of this object.
protected:

#include "amma/DP/Entity.hh"
const DPEntityC & operator=(const DPEntityC & dat)
Assignment.

DPEntityBodyC & Body()
Access body.

const DPEntityBodyC & Body() const
Access body.

BooleanT Save(ostream & out) const

#include "amma/RCHandle.hh"
BooleanT IsValid() const
Check its a valid handle.

BooleanT IsValidObject() const
Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<DPEntityBodyC> & operator=(const RCHandleC<DPEntityBodyC> & oth)
Assignment.

BooleanT operator==(const RCHandleC<DPEntityBodyC> & oth) const
Comparison operator.

BooleanT operator!=(const RCHandleC<DPEntityBodyC> & oth) const
Comparison operator.

UIntT Hash() const
Hash function.x

BooleanT IsConst() const
Is object constant ?

BooleanT IsNotConst() const
Is object not constant ?

void SetConst(void) const
Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()
Turn this into an invalid handle.

DPEntityBodyC & Body()
Direct access to body.

const DPEntityBodyC & Body() const
Constant access to body.


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001