ScriptModule
Public Slots | List of all members
Attribute Class Reference

The Attribute class represents user defined attributes in modules in the current rendering context. Attributes can be retrieved through the Context or Module objects. More...

#include <ScriptInterface.h>

Inheritance diagram for Attribute:
Inheritance graph
[legend]
Collaboration diagram for Attribute:
Collaboration graph
[legend]

Public Slots

virtual bool boolValue () const
 Fetch boolean value from Attribute at current frame.
 
virtual int intValue () const
 Fetch integer value from Attribute at current frame.
 
virtual double doubleValue () const
 Fetch double value from Attribute at current frame.
 
virtual String stringValue () const
 Fetch String value from Attribute at current frame.
 
virtual ColorRGBA colorValue ()
 Fetch ColorRGBA value from Attribute at current frame.
 
virtual Point2d pos2dValue ()
 Fetch Point2d value from Attribute at current frame.
 
virtual Point3d pos3dValue ()
 Fetch Point3d value from Attribute at current frame.
 
virtual bool boolValueAt (const double frame) const
 Fetch boolean value from Attribute at specified frame.
 
virtual int intValueAt (const double frame) const
 Fetch integer value from Attribute at specified frame.
 
virtual double doubleValueAt (const double frame) const
 Fetch double value from Attribute at specified frame.
 
virtual String stringValueAt (const double frame) const
 Fetch String value from Attribute at specified frame.
 
virtual ColorRGBA colorValueAt (const double frame)
 Fetch ColorRGBA value from Attribute at specified frame.
 
virtual Point2d pos2dValueAt (const double frame)
 Fetch Point2d value from Attribute at specified frame.
 
virtual Point3d pos3dValueAt (const double frame)
 Fetch Point3d value from Attribute at specified frame.
 

Detailed Description

The Attribute class represents user defined attributes in modules in the current rendering context. Attributes can be retrieved through the Context or Module objects.

Member Function Documentation

virtual bool Attribute::boolValue ( ) const
virtualslot

Fetch boolean value from Attribute at current frame.

Returns
bool value, or false if cannot cast to bool
virtual bool Attribute::boolValueAt ( const double  frame) const
virtualslot

Fetch boolean value from Attribute at specified frame.

Parameters
frameFrame number
Returns
bool value, or false if cannot cast to bool
virtual ColorRGBA Attribute::colorValue ( )
virtualslot

Fetch ColorRGBA value from Attribute at current frame.

Returns
ColorRGBA value, or (255,255,255,255) if cannot cast to ColorRGBA
virtual ColorRGBA Attribute::colorValueAt ( const double  frame)
virtualslot

Fetch ColorRGBA value from Attribute at specified frame.

Parameters
frameFrame number
Returns
ColorRGBA value, or (255,255,255,255) if cannot cast to ColorRGBA
virtual double Attribute::doubleValue ( ) const
virtualslot

Fetch double value from Attribute at current frame.

Returns
double value, or 0.0 if cannot cast to double
virtual double Attribute::doubleValueAt ( const double  frame) const
virtualslot

Fetch double value from Attribute at specified frame.

Parameters
frameFrame number
Returns
double value, or 0.0 if cannot cast to double
virtual int Attribute::intValue ( ) const
virtualslot

Fetch integer value from Attribute at current frame.

Returns
int value, or 0 if cannot cast to int
virtual int Attribute::intValueAt ( const double  frame) const
virtualslot

Fetch integer value from Attribute at specified frame.

Parameters
frameFrame number
Returns
int value, or 0 if cannot cast to int
virtual Point2d Attribute::pos2dValue ( )
virtualslot

Fetch Point2d value from Attribute at current frame.

Returns
Point2d value, or (0,0) if cannot cast to Point2d
virtual Point2d Attribute::pos2dValueAt ( const double  frame)
virtualslot

Fetch Point2d value from Attribute at specified frame.

Parameters
frameFrame number
Returns
Point2d value, or (0,0) if cannot cast to Point2d
virtual Point3d Attribute::pos3dValue ( )
virtualslot

Fetch Point3d value from Attribute at current frame.

Returns
Point3d value, or (0,0,0) if cannot cast to Point3d
virtual Point3d Attribute::pos3dValueAt ( const double  frame)
virtualslot

Fetch Point3d value from Attribute at specified frame.

Parameters
frameFrame number
Returns
Point3d value, or (0,0,0) if cannot cast to Point3d
virtual String Attribute::stringValue ( ) const
virtualslot

Fetch String value from Attribute at current frame.

Returns
String value, or empty String if cannot cast to String
virtual String Attribute::stringValueAt ( const double  frame) const
virtualslot

Fetch String value from Attribute at specified frame.

Parameters
frameFrame number
Returns
String value, or empty String if cannot cast to String

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