ImageGeometry Class Reference

#include <ImageGeometry.h>

Inheritance diagram for ImageGeometry:
Inheritance graph
[legend]

List of all members.

Public Types

enum   _State { kDisabled = 0, kEnabled = 1, kUseContext }
enum   { kDirtyImage = Geometry::kLastDirty, kLastDirty }
typedef enum
awScene::ImageGeometry::_State 
State

Public Member Functions

  ImageGeometry (bool usesXYPlane=true, const awString::IString &matType="Images")
  ImageGeometry (const ImageGeometry &)
ImageGeometry operator= (const ImageGeometry &)
void  setImagePath (const awString::IString &path)
const awString::IString &  getImagePath () const
void  setBlendSourceFunction (const awString::IString &)
  These values should be one of the ones described in the CgFx 1.4 spec.
const awString::IString &  getBlendSourceFunction () const
void  setBlendDestinationFunction (const awString::IString &)
const awString::IString &  getBlendDestinationFunction () const
int  getOrientationConstraint () const
  The value is one of the Orientation enum values.
void  setOrientationConstraint (int)
bool  getIsFixedPixelSize () const
  Fixed pixel size means that scale and zoom will be "ignored".
void  setIsFixedPixelSize (bool)
float  getExplicitWidth () const
  By default, the width and height are set to 1.0/1.0.
void  setExplicitWidth (float)
float  getExplicitHeight () const
void  setExplicitHeight (float)
float  getFixedPixelWidth () const
  By default, the fixed pixel width and height are set to -1.0 (use the image resolution).
void  setFixedPixelWidth (float)
float  getFixedPixelHeight () const
void  setFixedPixelHeight (float)
State  getDepthState () const
bool  setDepthState (State newDepthState)
bool  usesXYPlane () const
void  setMinFilterMode (const awString::IString &)
const awString::IString &  getMinFilterMode () const
void  setMagFilterMode (const awString::IString &)
const awString::IString &  getMagFilterMode () const
void  setWrapMode (const awString::IString &toSet)
  Currently we assume that each coordinate S,R and T wrap in the exact same way.
const awString::IString &  getWrapMode () const
void  setColor (float r, float g, float b, float a)
void  useColor (bool useColor)
virtual void  accept (NodeVisitor &)
virtual void  setAllDirty (bool dirty)

Protected Member Functions

virtual  ~ImageGeometry ()
  Reference counted objects shouldn't exist on the stack.
void  createMaterial ()

Member Typedef Documentation


Member Enumeration Documentation


Constructor & Destructor Documentation

ImageGeometry ( bool  usesXYPlane = true,
const awString::IString &  matType = "Images" 
) [explicit]
virtual ~ImageGeometry ( ) [protected, virtual]

Reference counted objects shouldn't exist on the stack.


Member Function Documentation

ImageGeometry& operator= ( const ImageGeometry )
void setImagePath ( const awString::IString &  path )
const awString::IString& getImagePath ( ) const
void setBlendSourceFunction ( const awString::IString &  )

These values should be one of the ones described in the CgFx 1.4 spec.

For example, SrcAlpha, OneMinusSrcAlpha, Zero, One, DstAlpha, OneMinusDestColor, etc. There are no tests for the validity, so be careful.

const awString::IString& getBlendSourceFunction ( ) const
void setBlendDestinationFunction ( const awString::IString &  )
const awString::IString& getBlendDestinationFunction ( ) const
int getOrientationConstraint ( ) const

The value is one of the Orientation enum values.

If set to kOrientToCameraAlways, the image will always automatically rotate to face the camera. If fixed pixel size is true, then the image will also be automatically scaled to be a constant size on screen.

If set to kOrientToCameraAroundZ, the image will always rotate around the up (Z) axis to face the camera, but will not adjust the scale or "elevation" rotation.

If set to kNoOrientationConstraint, the image will not change in orientation. If fixed pixel size is true, then the image will be automatically scaled to be a constant size on screen.

In all cases, the position is freely controlled by the group parent of this node.

void setOrientationConstraint ( int  )
bool getIsFixedPixelSize ( ) const

Fixed pixel size means that scale and zoom will be "ignored".

Currently only supported if the orientation constraints are kOrientToCameraAlways or kNoOrientationConstraint.

void setIsFixedPixelSize ( bool  )
float getExplicitWidth ( ) const

By default, the width and height are set to 1.0/1.0.

If you want that changed, set the values explicitly. If you set them to -1, the actual pixel size of the image will be used instead.

void setExplicitWidth ( float  )
float getExplicitHeight ( ) const
void setExplicitHeight ( float  )
float getFixedPixelWidth ( ) const

By default, the fixed pixel width and height are set to -1.0 (use the image resolution).

Change the fixed pixel size in this method.

void setFixedPixelWidth ( float  )
float getFixedPixelHeight ( ) const
void setFixedPixelHeight ( float  )
State getDepthState ( ) const
bool setDepthState ( State  newDepthState )
bool usesXYPlane ( ) const
void setMinFilterMode ( const awString::IString &  )
const awString::IString& getMinFilterMode ( ) const
void setMagFilterMode ( const awString::IString &  )
const awString::IString& getMagFilterMode ( ) const
void setWrapMode ( const awString::IString &  toSet )

Currently we assume that each coordinate S,R and T wrap in the exact same way.

const awString::IString& getWrapMode ( ) const
void setColor ( float  r,
float  g,
float  b,
float  a 
)
void useColor ( bool  useColor )
virtual void accept ( NodeVisitor ) [virtual]
virtual void setAllDirty ( bool  dirty ) [virtual]

Reimplemented from Node.

void createMaterial ( ) [protected]

ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry
ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry ImageGeometry