hoa_video::StillImage

hoa_video::StillImage Class Reference

Represents a single or compound still image StillImages may be simple images or compound images. Compound images are created when you stitch together multiple smaller images to create a single large image (e.g. with TilesToObject() function). It's fine to think of compound images as just a single image. More...

#include <image.h>

Inheritance diagram for hoa_video::StillImage:

Inheritance graph
[legend]
Collaboration diagram for hoa_video::StillImage:

Collaboration graph
[legend]
List of all members.

Public Member Functions

bool AddImage (const StillImage &id, float x_offset, float y_offset, float u1=0.0f, float v1=0.0f, float u2=1.0f, float v2=1.0f)
 AddImage allows the user to create compound images.
void Clear ()
 Clears the image by resetting its properties.
void DisableGrayScale ()
 Disables grayscaling for the image then reloads it.
void EnableGrayScale ()
 Enables grayscaling for the image then reloads it.
 StillImage (const bool grayscale=false)
Class Member Get Functions
std::string GetFilename () const
 Returns the filename of the image.
float GetHeight () const
 Returns the height of the image.
void GetVertexColor (Color &c, uint8 index)
 Returns the color of a particular vertex.
float GetWidth () const
 Returns the width of the image.
Class Member Set Functions
void SetColor (const Color &color)
 Sets the color for the image (for all four verteces).
void SetDimensions (const float width, const float height)
 Sets the dimensions (width, height) of the image.
void SetFilename (const std::string &filename)
 Sets the filename of the image.
void SetHeight (const float height)
 Sets height of the image.
void SetStatic (const bool is_static)
 Sets image to static/animated.
void SetVertexColors (const Color &tl, const Color &tr, const Color &bl, const Color &br)
 Sets individual vertex colors in the image.
void SetWidth (const float width)
 Sets width of the image.

Private Attributes

std::vector< private_video::ImageElement > _elements
 The internal images that make the still image If the image is not a compound image, then this vector will contain a single element.
std::string _filename
 The name of the image file from which this image was created This is used for loading an image (SetFilename(), Load()), so after loading, it has no purpose. If we have a compound image, these will be an empty string.

Friends

class AnimatedImage
class GameVideo
class private_video::ParticleSystem

Detailed Description

Represents a single or compound still image StillImages may be simple images or compound images. Compound images are created when you stitch together multiple smaller images to create a single large image (e.g. with TilesToObject() function). It's fine to think of compound images as just a single image.

****************************************************************************

Definition at line 341 of file image.h.

Constructor & Destructor Documentation

hoa_video::StillImage::StillImage ( const bool  grayscale = false  ) 

Definition at line 188 of file image.cpp.

References hoa_video::ImageDescriptor::_animated, hoa_video::ImageDescriptor::_grayscale, and Clear().

Here is the call graph for this function:

Member Function Documentation

bool hoa_video::StillImage::AddImage ( const StillImage &  id,
float  x_offset,
float  y_offset,
float  u1 = 0.0f,
float  v1 = 0.0f,
float  u2 = 1.0f,
float  v2 = 1.0f 
)

AddImage allows the user to create compound images.

Parameters:
id The image to add to the compound image.
x_offset The x offset of the compound image.
y_offset The y offset of the compound image.
u1 The upper-left u coordinate for the image. The default is 0.0f.
v1 The upper-left v coordinate for the image. The default is 0.0f.
u2 The lower-right u coordinate for the image. The default is 1.0f.
v2 The lower-right v coordinate for the image. The default is 1.0f.
Starting with a newly created StillImage, call AddImage(), for all of the images you wish to add, along with the x and y offsets that they should be positioned at. The u1, v1, u2, v2 coordinates tell which portion of the image to use (usually 0, 0, 1, 1)

Definition at line 350 of file image.cpp.

References _elements, hoa_video::ImageDescriptor::_height, hoa_video::ImageDescriptor::_width, and hoa_video::VIDEO_DEBUG.

Referenced by hoa_video::MenuWindow::_RecreateImage().

void hoa_video::StillImage::Clear (  )  [virtual]

Clears the image by resetting its properties.

Implements hoa_video::ImageDescriptor.

Definition at line 196 of file image.cpp.

References hoa_video::ImageDescriptor::_Clear(), _elements, _filename, SetColor(), and hoa_video::Color::white.

Referenced by hoa_video::MenuWindow::_RecreateImage(), and StillImage().

Here is the call graph for this function:

void hoa_video::StillImage::DisableGrayScale (  ) 

Disables grayscaling for the image then reloads it.

Definition at line 303 of file image.cpp.

References _elements, hoa_video::ImageDescriptor::_grayscale, hoa_video::GameVideo::_images, hoa_video::VIDEO_DEBUG, and hoa_video::VideoManager.

Referenced by hoa_video::AnimatedImage::DisableGrayScale().

void hoa_video::StillImage::EnableGrayScale (  ) 

Enables grayscaling for the image then reloads it.

Definition at line 240 of file image.cpp.

References hoa_video::GameVideo::_ConvertImageToGrayscale(), _elements, hoa_video::GameVideo::_GetBufferFromImage(), hoa_video::ImageDescriptor::_grayscale, hoa_video::GameVideo::_images, hoa_video::GameVideo::_InsertImageInTexSheet(), hoa_video::ImageDescriptor::_is_static, hoa_video::private_video::Image::filename, hoa_video::private_video::ImageLoadInfo::height, hoa_video::private_video::ImageLoadInfo::pixels, hoa_video::private_video::Image::ref_count, hoa_video::private_video::Image::tags, hoa_video::VIDEO_DEBUG, hoa_video::VideoManager, and hoa_video::private_video::ImageLoadInfo::width.

Referenced by hoa_video::AnimatedImage::EnableGrayScale().

Here is the call graph for this function:

std::string hoa_video::StillImage::GetFilename (  )  const [inline]

Returns the filename of the image.

Definition at line 422 of file image.h.

References _filename.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_map::MapMode::_Load(), hoa_menu::private_menu::EquipWindow::_UpdateEquipList(), hoa_menu::private_menu::InventoryWindow::_UpdateItemText(), hoa_map::private_map::DialogueManager::DialogueManager(), and hoa_menu::private_menu::EquipWindow::EquipWindow().

float hoa_video::StillImage::GetHeight (  )  const [inline, virtual]

Returns the height of the image.

Implements hoa_video::ImageDescriptor.

Definition at line 430 of file image.h.

References hoa_video::ImageDescriptor::_height.

Referenced by hoa_video::MenuWindow::_RecreateImage().

void hoa_video::StillImage::GetVertexColor ( Color &  c,
uint8  index 
) [inline]

Returns the color of a particular vertex.

Parameters:
c The Color object to place the color in.
index The vertex index of the color to fetch
Note:
If an invalid index value is used, the function will return with no warning.

Definition at line 438 of file image.h.

References hoa_video::ImageDescriptor::_color.

Referenced by hoa_video::MenuWindow::_RecreateImage().

float hoa_video::StillImage::GetWidth (  )  const [inline, virtual]

Returns the width of the image.

Implements hoa_video::ImageDescriptor.

Definition at line 426 of file image.h.

References hoa_video::ImageDescriptor::_width.

Referenced by hoa_video::MenuWindow::_RecreateImage(), hoa_video::OptionBox::Draw(), and hoa_video::GameVideo::GetDefaultCursor().

void hoa_video::StillImage::SetColor ( const Color &  color  )  [inline, virtual]

Sets the color for the image (for all four verteces).

Parameters:
color Colors for the 4 vertex of the image

Implements hoa_video::ImageDescriptor.

Definition at line 406 of file image.h.

References hoa_video::ImageDescriptor::_color.

Referenced by Clear(), hoa_video::GameVideo::Display(), and hoa_video::AnimatedImage::SetColor().

void hoa_video::StillImage::SetDimensions ( const float  width,
const float  height 
) [virtual]

Sets the dimensions (width, height) of the image.

Parameters:
width Width of the image
height Height of the image

Implements hoa_video::ImageDescriptor.

Definition at line 227 of file image.cpp.

References _elements, hoa_video::ImageDescriptor::_height, and hoa_video::ImageDescriptor::_width.

Referenced by hoa_video::MenuWindow::_RecreateImage(), hoa_battle::BattleMode::_TEMP_LoadTestData(), hoa_video::AnimatedImage::AddFrame(), hoa_battle::private_battle::BattleActor::BattleActor(), hoa_battle::private_battle::BattleCharacterActor::BattleCharacterActor(), hoa_battle::private_battle::BattleEnemyActor::BattleEnemyActor(), hoa_battle::BattleMode::BattleMode(), hoa_boot::BootMode::BootMode(), hoa_video::GameVideo::Display(), hoa_video::GameVideo::DrawFullscreenOverlay(), hoa_global::GlobalCharacter::GlobalCharacter(), hoa_menu::private_menu::CharacterWindow::SetCharacter(), hoa_video::AnimatedImage::SetDimensions(), and hoa_menu::private_menu::StatusWindow::StatusWindow().

void hoa_video::StillImage::SetFilename ( const std::string &  filename  )  [inline]

Sets the filename of the image.

Parameters:
filename Name of the fle to load

Definition at line 378 of file image.h.

References _filename.

Referenced by hoa_video::OptionBox::_ConstructOption(), hoa_map::MapMode::_Load(), hoa_battle::BattleMode::_TEMP_LoadTestData(), hoa_menu::private_menu::EquipWindow::_UpdateEquipList(), hoa_video::AnimatedImage::AddFrame(), hoa_battle::private_battle::BattleActor::BattleActor(), hoa_battle::private_battle::BattleCharacterActor::BattleCharacterActor(), hoa_battle::private_battle::BattleEnemyActor::BattleEnemyActor(), hoa_battle::BattleMode::BattleMode(), hoa_boot::BootMode::BootMode(), hoa_map::private_map::DialogueManager::DialogueManager(), hoa_menu::private_menu::EquipWindow::EquipWindow(), hoa_global::GlobalArmor::GlobalArmor(), hoa_global::GlobalItem::GlobalItem(), hoa_global::GlobalWeapon::GlobalWeapon(), hoa_menu::private_menu::CharacterWindow::SetCharacter(), hoa_video::GameVideo::SetDefaultCursor(), hoa_map::private_map::VirtualSprite::SetFacePortrait(), hoa_global::GameGlobal::SetLocation(), hoa_video::GameVideo::SingletonInitialize(), and hoa_menu::private_menu::StatusWindow::StatusWindow().

void hoa_video::StillImage::SetHeight ( const float  height  )  [virtual]

Sets height of the image.

Parameters:
height Height of the image

Implements hoa_video::ImageDescriptor.

Definition at line 216 of file image.cpp.

References _elements, and hoa_video::ImageDescriptor::_height.

Referenced by hoa_video::AnimatedImage::SetHeight().

void hoa_video::StillImage::SetStatic ( const bool  is_static  )  [inline, virtual]

Sets image to static/animated.

Parameters:
is_static Flag indicating wether the image should be made static or not

Implements hoa_video::ImageDescriptor.

Definition at line 400 of file image.h.

References hoa_video::ImageDescriptor::_is_static.

Referenced by hoa_video::AnimatedImage::AddFrame(), hoa_menu::private_menu::CharacterWindow::SetCharacter(), and hoa_menu::private_menu::StatusWindow::StatusWindow().

void hoa_video::StillImage::SetVertexColors ( const Color &  tl,
const Color &  tr,
const Color &  bl,
const Color &  br 
) [inline, virtual]

Sets individual vertex colors in the image.

Parameters:
tl top left vertex color
tr top right vertex color
bl bottom left vertex color
br bottom right vertex color

Implements hoa_video::ImageDescriptor.

Definition at line 415 of file image.h.

References hoa_video::ImageDescriptor::_color.

Referenced by hoa_video::MenuWindow::_RecreateImage(), hoa_video::AnimatedImage::AddFrame(), and hoa_video::AnimatedImage::SetVertexColors().

void hoa_video::StillImage::SetWidth ( const float  width  )  [virtual]

Sets width of the image.

Parameters:
width Width of the image

Implements hoa_video::ImageDescriptor.

Definition at line 205 of file image.cpp.

References _elements, and hoa_video::ImageDescriptor::_width.

Referenced by hoa_video::AnimatedImage::SetWidth().

Friends And Related Function Documentation

friend class AnimatedImage [friend]

Definition at line 343 of file image.h.

friend class GameVideo [friend]

Reimplemented from hoa_video::ImageDescriptor.

Definition at line 342 of file image.h.

friend class private_video::ParticleSystem [friend]

Definition at line 344 of file image.h.

Member Data Documentation

std::vector<private_video::ImageElement> hoa_video::StillImage::_elements [private]

The internal images that make the still image If the image is not a compound image, then this vector will contain a single element.

Definition at line 452 of file image.h.

Referenced by hoa_video::AnimatedImage::AddFrame(), AddImage(), Clear(), DisableGrayScale(), hoa_video::private_video::ParticleSystem::Draw(), hoa_video::GameVideo::DrawRectangle(), EnableGrayScale(), hoa_video::GameVideo::SaveImage(), SetDimensions(), SetHeight(), and SetWidth().

std::string hoa_video::StillImage::_filename [private]

The name of the image file from which this image was created This is used for loading an image (SetFilename(), Load()), so after loading, it has no purpose. If we have a compound image, these will be an empty string.

Definition at line 447 of file image.h.

Referenced by Clear(), GetFilename(), and SetFilename().

The documentation for this class was generated from the following files:
Generated on Fri Jul 6 23:16:40 2007 for Hero of Allacrost by  doxygen 1.5.1