Image2D Class Reference

MetaObject implementing Image2D Object Type. More...

#include <image2D.hh>

Inheritance diagram for Image2D:

List of all members.

Public Member Functions

• Image2D (MetaObject *superobject)

  Constructor.
  
  

• virtual ~Image2D ()

  Destructor.
  
  

• virtual const string getType ()

  Return type string ("image2D").
  
  

• virtual void setPropertyAccessControl (PropertyAccessControl *ac)

  Set default access control policy for subobjects.
  
  

• virtual PropertyAccessControl * getPropertyAccessControl ()

  Get default access control policy for subobjects.
  
  

• virtual string getImageDatatype ()

  Get the datatype of image2D:image property.
  
  

• virtual void setImage (const string &value, const string &datatype="?", PropertyAccessControl *ac=NULL)

  Set image property.
  
  

• virtual void setImageFromFile (const string &filename, const string &datatype="?", PropertyAccessControl *ac=NULL)

  Set contents of image property with dat aread from file.
  
  

• virtual int getImageLength ()

  Get size of image data (in bytes).
  
  

Access Subobjects

• virtual void getPosition (double &x, double &y)

  Get the value of position property.
  
  

• virtual void setPosition (double x, double y, PropertyAccessControl *ac=NULL)

  Set position property.
  
  

• virtual double getOrientation ()

  Get the value of orientation property.
  
  

• virtual void setOrientation (double o, PropertyAccessControl *ac=NULL)

  Set orientation property.
  
  

• virtual void getScaling (double &x, double &y)

  Get the values of scaling property.
  
  

• virtual void setScaling (double x, double y, PropertyAccessControl *ac=NULL)

  Set caling property.
  
  

Access Subobjects

• virtual string getImage ()
• virtual void getImage (string &s)

Static Public Member Functions

• void registerExtenders ()

  Register Extenders.
  
  

Protected Attributes

• PropertyAccessControl * accessControl

---

Detailed Description

MetaObject implementing Image2D Object Type.

Base object type for 2D image objects: provides position, orientation and size properties. These three properties define a transformation for this 2D image relative to its parent image. An image should be displayed superimposed on top of its parent image, and its child image objects should be displayed superimposed on top of it.

Definition at line 33 of file image2D.hh.

---

Constructor & Destructor Documentation

Image2D::Image2D (  MetaObject *  superobject  )

Constructor. Definition at line 33 of file image2D.cc.

Image2D::~Image2D (   )  [virtual]

Destructor. Definition at line 38 of file image2D.cc.

---

Member Function Documentation

void Image2D::getImage (  string &  s  )  [virtual]

Definition at line 166 of file image2D.cc.

string Image2D::getImage (   )  [virtual]

This is the image data. The datatype indicates the data format. Suggested datatypes to support are: PNG, JPEG, BMP, TIFF, PCX, PNM, and XPM. Definition at line 158 of file image2D.cc.

string Image2D::getImageDatatype (   )  [virtual]

Get the datatype of image2D:image property. Definition at line 173 of file image2D.cc.

int Image2D::getImageLength (   )  [virtual]

Get size of image data (in bytes). Definition at line 201 of file image2D.cc.

double Image2D::getOrientation (   )  [virtual]

Get the value of orientation property. This is the orientation or rotation of this object relative to the orientation of its parent image object (clockwise). Definition at line 123 of file image2D.cc.

void Image2D::getPosition (  double &  x, double &  y )  [virtual]

Get the value of position property. This is the position or translation of this object relative to the origin of its parent image object. Definition at line 106 of file image2D.cc.

virtual PropertyAccessControl* Image2D::getPropertyAccessControl (   )  [inline, virtual]

Get default access control policy for subobjects. Definition at line 58 of file image2D.hh.

void Image2D::getScaling (  double &  x, double &  y )  [virtual]

Get the values of scaling property. This is the size of this object, and a scaling transformation to apply to all children of this object. All objects under the same 2D object or space with the same scaling value should be rendered at the same size (regardless of the size of the shape/bitmap itself). Definition at line 142 of file image2D.cc.

const string Image2D::getType (   )  [virtual]

Return type string ("image2D"). Definition at line 90 of file image2D.cc.

void Image2D::registerExtenders (   )  [static]

Register Extenders. Definition at line 95 of file image2D.cc.

void Image2D::setImage (  const string &  value, const string &  datatype = "?", PropertyAccessControl *  ac = NULL )  [virtual]

Set image property. Parameters: value  The new value datatype  The new datatype: if omitted, then the existing datatype will be preserved. Definition at line 179 of file image2D.cc. Referenced by LocalImage2D::initialize(), and setImageFromFile().

void Image2D::setImageFromFile (  const string &  filename, const string &  datatype = "?", PropertyAccessControl *  ac = NULL )  [virtual]

Set contents of image property with dat aread from file. Parameters: filename  Filename datatype  The datatype Definition at line 186 of file image2D.cc.

void Image2D::setOrientation (  double  o, PropertyAccessControl *  ac = NULL )  [virtual]

Set orientation property. Definition at line 134 of file image2D.cc. Referenced by LocalImage2D::initialize().

void Image2D::setPosition (  double  x, double  y, PropertyAccessControl *  ac = NULL )  [virtual]

Set position property. Definition at line 115 of file image2D.cc. Referenced by LocalImage2D::initialize().

virtual void Image2D::setPropertyAccessControl (  PropertyAccessControl *  ac  )  [inline, virtual]

Set default access control policy for subobjects. Definition at line 53 of file image2D.hh.

void Image2D::setScaling (  double  x, double  y, PropertyAccessControl *  ac = NULL )  [virtual]

Set caling property. Definition at line 150 of file image2D.cc. Referenced by LocalImage2D::initialize().

---

Member Data Documentation

PropertyAccessControl* Image2D::accessControl [protected]

Definition at line 36 of file image2D.hh. Referenced by getPropertyAccessControl(), Image2D(), LocalImage2D::initialize(), setImage(), setOrientation(), setPosition(), setPropertyAccessControl(), and setScaling().

---

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

• vos/metaobjects/image2D/image2D.hh
• vos/metaobjects/image2D/image2D.cc

---