Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
Fusion::IObject

Fusion::IObject Class Reference

#include <FusionIObject.h>

Inheritance diagram for Fusion::IObject:

Fusion::Object Emma::AggRenderManager Emma::Color Emma::MFField Emma::MFNode Emma::Node Emma::PlaneProj Emma::RenderManager Emma::SFMatrix3D Emma::SFURL Emma::SFValue Emma::Stream Emma::Translator Fusion::Array Fusion::Date Fusion::File Fusion::Math List of all members.

Public Member Functions

virtual ResultType initializeClass ()=0
 Initialize this class.
virtual ResultType finalizeClass ()=0
 Finalize this class before it is destroyed.
virtual ResultType initialize ()=0
 Initialize this instance.
virtual ResultType finalize ()=0
 Finalize this instance before it is destroyed.
virtual ResultType setProperty (const Id &, const Value &)=0
 Set a property of this object to the passed value. Id can be a string or numeric property.
virtual ResultType getProperty (const Id &id, Value &val) const =0
 Get a property of this object and place it in the passed value. Id can be a string or numeric property.
virtual ResultType getValue (Value &s, HintType=HINT_NONE) const =0
 Get the value of this object.
virtual ResultType setValue (const Value &val)=0
 Set the value of this object to the passed value, if possible.
virtual ResultType callProperty (const Id &id, Value &retval) const =0
 Call the passed property of this object, which is assumed to be a function or callable object.
virtual ResultType callProperty (const Id &id, Value &retval, const Value &val) const =0
 Call the passed property of this object, which is assumed to be a function or callable object.
virtual ResultType callProperty (const Id &id, Value &retval, Args &args, int32_t nargs) const =0
 Call the passed property of this object, which is assumed to be a function or callable object.
virtual Value valueOf () const =0
 Convert this object to a primitive value.
virtual ResultType toString (UTF8String &s) const =0
 Convert this object to a string.
virtual double getDouble () const =0
 Convert this object to a string.
virtual bool isBoolean () const =0
 Return true if this object represents a primitive boolean value.
virtual bool isNumber () const =0
 Return true if this object represents a primitive numeric value.
virtual bool isString () const =0
 Return true if this object represents a primitive string value.
virtual UTF8String getName () const =0
 Return a string representing the name of this object. The meaning of this name is object dependent.
virtual void unref ()=0
 Add a reference to this object to prevent it from being removed by the garbage collector.
virtual void ref ()=0
 Remove a reference from an object, when this object has no more refs, it is subject to GC.
virtual void registerInterface (const UTF8String &name, const Value &iface, const UTF8String &imp)=0
 Register an interface for this object.
virtual IObject * queryInterface (const UTF8String &name)=0
 Return the object that implements the passed interface.

Member Function Documentation

virtual ResultType Fusion::IObject::callProperty (  const Id &  id,
Value &  retval,
Args &  args,
int32_t  nargs
)  const [pure virtual]
 

Call the passed property of this object, which is assumed to be a function or callable object.

Any returned value is placed in retval. The nargs parameter has the number of arguments passed. Actual arguments are on the Lua stack, which is referenced in args.

Implemented in Fusion::Object.

virtual ResultType Fusion::IObject::callProperty (  const Id &  id,
Value &  retval,
const Value &  val
)  const [pure virtual]
 

Call the passed property of this object, which is assumed to be a function or callable object.

Any returned value is placed in retval. One argument is passed in val.

Implemented in Fusion::Object.

virtual ResultType Fusion::IObject::callProperty (  const Id &  id,
Value &  retval
)  const [pure virtual]
 

Call the passed property of this object, which is assumed to be a function or callable object.

Any returned value is placed in retval. No arguments are passed.

Implemented in Fusion::Object.

virtual ResultType Fusion::IObject::finalize (   )  [pure virtual]
 

Finalize this instance before it is destroyed.

Implemented in Fusion::Object, Emma::AggRenderManager, Emma::ButtonSensor, Emma::DropSensor, Emma::Timer, Emma::ValueSensor, Emma::Viewpoint, Emma::WindowSensor, Emma::WxGUI, Emma::RenderManager, and Emma::XmaTranslator.

virtual ResultType Fusion::IObject::finalizeClass (   )  [pure virtual]
 

Finalize this class before it is destroyed.

Implemented in Fusion::Object.

virtual double Fusion::IObject::getDouble (   )  const [pure virtual]
 

Convert this object to a string.

Implemented in Emma::SFURL, Emma::SFValue, and Fusion::Object.

virtual UTF8String Fusion::IObject::getName (   )  const [pure virtual]
 

Return a string representing the name of this object. The meaning of this name is object dependent.

Implemented in Fusion::Object.

virtual ResultType Fusion::IObject::getProperty (  const Id &  id,
Value &  val
)  const [pure virtual]
 

Get a property of this object and place it in the passed value. Id can be a string or numeric property.

Implemented in Fusion::Object.

virtual ResultType Fusion::IObject::getValue (  Value &  s,
HintType  = HINT_NONE
)  const [pure virtual]
 

Get the value of this object.

If this object cannot be converted to a primitive, return the object as the value. If HintType is given attempt to convert this object to the passed primitive type. If this is not possible, ignore HintType.

Implemented in Fusion::Object.

virtual ResultType Fusion::IObject::initialize (   )  [pure virtual]
 

Initialize this instance.

Implemented in Emma::MFField, Emma::MFNode, Emma::SFMatrix3D, Emma::SFURL, Emma::SFValue, Emma::Stream, Fusion::Array, Fusion::Date, Fusion::Object, Emma::EmaTranslator, Emma::AggRenderManager, Emma::MeshTranslator, Emma::Client, Emma::Server, Emma::SvgInline, Emma::Text2D, Emma::BackgroundInline, Emma::DirectionalLight, Emma::Fog, Emma::Material, Emma::MaterialInline, Emma::Mesh, Emma::MeshAnimation, Emma::MeshInline, Emma::MeshInterpolator, Emma::ParticleInline, Emma::PointLight, Emma::SceneSurface, Emma::SpotLight, Emma::SurfaceNode, Emma::ButtonSensor, Emma::Camera, Emma::DropSensor, Emma::Environment, Emma::Group, Emma::Shape, Emma::ValueSensor, Emma::Viewpoint, Emma::WindowSensor, Emma::RenderManager, Emma::XmaTranslator, Emma::PlaneSensor, Emma::SphereSensor, and Emma::NavigatorNode.

virtual ResultType Fusion::IObject::initializeClass (   )  [pure virtual]
 

Initialize this class.

Implemented in Fusion::Object.

virtual bool Fusion::IObject::isBoolean (   )  const [pure virtual]
 

Return true if this object represents a primitive boolean value.

Implemented in Emma::SFValue, and Fusion::Object.

virtual bool Fusion::IObject::isNumber (   )  const [pure virtual]
 

Return true if this object represents a primitive numeric value.

Implemented in Emma::SFURL, Emma::SFValue, and Fusion::Object.

virtual bool Fusion::IObject::isString (   )  const [pure virtual]
 

Return true if this object represents a primitive string value.

Implemented in Emma::SFURL, Emma::SFValue, and Fusion::Object.

virtual IObject* Fusion::IObject::queryInterface (  const UTF8String &  name  )  [pure virtual]
 

Return the object that implements the passed interface.

Implemented in Fusion::Object.

virtual void Fusion::IObject::ref (   )  [pure virtual]
 

Remove a reference from an object, when this object has no more refs, it is subject to GC.

Implemented in Fusion::Object.

virtual void Fusion::IObject::registerInterface (  const UTF8String &  name,
const Value &  iface,
const UTF8String &  imp
)  [pure virtual]
 

Register an interface for this object.

Implemented in Fusion::Object.

virtual ResultType Fusion::IObject::setProperty (  const Id &  ,
const Value & 
)  [pure virtual]
 

Set a property of this object to the passed value. Id can be a string or numeric property.

Implemented in Fusion::Object, and Emma::RenderManager.

virtual ResultType Fusion::IObject::setValue (  const Value &  val  )  [pure virtual]
 

Set the value of this object to the passed value, if possible.

Implemented in Emma::MFField, Emma::MFNode, Emma::SFMatrix3D, Emma::SFURL, Emma::SFValue, Fusion::Array, and Fusion::Object.

virtual ResultType Fusion::IObject::toString (  UTF8String &  s  )  const [pure virtual]
 

Convert this object to a string.

Implemented in Emma::MFField, Emma::MFNode, Emma::Node, Emma::SFMatrix3D, Emma::SFURL, Emma::SFValue, Fusion::Array, Fusion::Date, and Fusion::Object.

virtual void Fusion::IObject::unref (   )  [pure virtual]
 

Add a reference to this object to prevent it from being removed by the garbage collector.

Implemented in Fusion::Object.

virtual Value Fusion::IObject::valueOf (   )  const [pure virtual]
 

Convert this object to a primitive value.

Implemented in Emma::SFValue, and Fusion::Object.

The documentation for this class was generated from the following file:
Generated on Sat Apr 1 06:08:34 2006 for Emma SDK Guide by  doxygen 1.4.3