Inheritance diagram for df::ViewObject:

Public Member Functions
	ViewObject ()

virtual int	draw () override

virtual int	eventHandler (const Event *p_e) override

virtual void	setLocation (ViewObjectLocation new_location)

ViewObjectLocation	getLocation () const

virtual void	setDrawValue (bool new_draw_value=true)

bool	getDrawValue () const

virtual void	setValue (int new_value)

int	getValue () const

virtual void	setBorder (bool new_border)

bool	getBorder () const

virtual void	setColor (Color new_color)

Color	getColor () const

virtual void	setViewString (std::string new_view_string)

std::string	getViewString () const

virtual int	setPosition (Vector new_pos) override

virtual int	serialize (std::stringstream *p_ss, unsigned int attr=0) override

virtual int	deserialize (std::stringstream p_ss, unsigned int p_a=NULL) override

std::string	toString () const

bool	operator== (const ViewObject &vo)

bool	operator!= (const ViewObject &vo)

Public Member Functions inherited from df::Object
	Object ()

virtual	~Object ()

void	setId (int new_id)

int	getId () const

virtual void	setType (std::string new_type)

std::string	getType () const

virtual int	setPosition (Vector new_position)

Vector	getPosition () const

virtual int	eventHandler (const Event *p_event)

bool	isSolid () const

virtual int	setSolidness (Solidness new_solid)

Solidness	getSolidness () const

void	setNoSoft (bool new_no_soft=true)

bool	getNoSoft () const

virtual void	setAvoidCollisions (bool new_avoid_collisions=true)

bool	getAvoidCollisions () const

virtual int	setAltitude (int new_altitude)

int	getAltitude () const

void	setSpeed (float speed)

float	getSpeed () const

virtual void	setDirection (Vector new_direction)

Vector	getDirection () const

virtual void	setVelocity (Vector velocity)

Vector	getVelocity () const

virtual void	setAcceleration (Vector new_acceleration)

Vector	getAcceleration () const

void	accelerate ()

Vector	predictPosition ()

void	pathTo (Vector position)

void	pathTo (Object *p_o_target)

void	moveTo (Vector new_position)

void	doPathFollowing ()

int	setVisible (bool new_visible=true)

virtual bool	isVisible () const

virtual int	setActive (bool new_active=true)

bool	isActive () const

virtual void	setBox (Box new_box)

Box	getBox () const

int	registerInterest (std::string event_type)

int	unregisterInterest (std::string event_type)

int	getEventCount () const

virtual int	setSprite (std::string sprite_label)

virtual void	setAnimation (Animation new_animation, bool set_box=true)

Animation	getAnimation () const

virtual int	draw ()

virtual int	serialize (std::stringstream *p_ss, unsigned int attr=0)

virtual int	deserialize (std::stringstream p_ss, unsigned int p_a=NULL)

bool	isModified (enum ObjectAttribute attribute) const

bool	isModified () const

virtual void	setModified (unsigned int new_modified)

virtual unsigned int	getModified () const

virtual void	setShape (Shape new_shape)

Shape	getShape () const

virtual void	setFollowPath (bool new_follow_path=true)

bool	getFollowPath () const

void	setPath (Path new_path)

Path	getPath () const

PathFind *	getPathFind ()

std::string	toString () const

bool	operator== (const Object &o)

bool	operator!= (const Object &o)

Private Attributes
std::string	m_view_string

int	m_value

bool	m_draw_value

bool	m_border

Color	m_color

ViewObjectLocation	m_location

Additional Inherited Members
Static Public Attributes inherited from df::Object
static int	max_id

Constructor & Destructor Documentation

◆ ViewObject()

df::ViewObject::ViewObject ( )

Construct ViewObject.

Object settings: SPECTRAL, max altitude. ViewObject defaults: border, top_center, default color, draw_value.

Member Function Documentation

◆ deserialize()

virtual int df::ViewObject::deserialize	(	std::stringstream *	p_ss,
		unsigned int *	p_a = `NULL`
	)

overridevirtual

Deserialize stream to attributes and apply.

p_ss - incoming stream to deserialize. p_a - outgoing bitmask of attributes modified (NULL means no outgoing). Return 0 if ok, else -1.

Reimplemented from df::Object.

Reimplemented in df::Button, df::TextBox, and df::TextEntry.

◆ draw()

virtual int df::ViewObject::draw ( )

overridevirtual

Draw view string (and value).

Return 0 if ok, negative if not.

Reimplemented from df::Object.

Reimplemented in df::TextBox, and df::TextEntry.

◆ eventHandler()

virtual int df::ViewObject::eventHandler ( const Event * p_e )

overridevirtual

Handle "view" event if tag matches view_string (others ignored).

Return 0 if ignored, else 1.

Reimplemented from df::Object.

Reimplemented in df::Button, df::Fraps, and df::TextEntry.

◆ getBorder()

bool df::ViewObject::getBorder ( ) const

Get view border (true = display border).

◆ getColor()

Color df::ViewObject::getColor ( ) const

Get view color.

◆ getDrawValue()

bool df::ViewObject::getDrawValue ( ) const

Get draw value (true if draw value with display string).

◆ getLocation()

ViewObjectLocation df::ViewObject::getLocation ( ) const

Get general location of ViewObject on screen.

◆ getValue()

int df::ViewObject::getValue ( ) const

Get view value.

◆ getViewString()

std::string df::ViewObject::getViewString ( ) const

Get view display string.

◆ operator==()

bool df::ViewObject::operator== ( const ViewObject & vo )

Compare two ViewObjects.

◆ serialize()

virtual int df::ViewObject::serialize	(	std::stringstream *	p_ss,
		unsigned int	attr = `0`
	)

overridevirtual

Serialize modified attributes to stream.

Can specify individual attribute(s) to force (modified or not). Default is only modified attributes. Clears modified bits for attributes serialized. Return 0 if ok, else -1.

Reimplemented from df::Object.

Reimplemented in df::Button, df::TextBox, and df::TextEntry.

◆ setBorder()

virtual void df::ViewObject::setBorder ( bool new_border )

virtual

Set view border (true = display border).

◆ setColor()

virtual void df::ViewObject::setColor ( Color new_color )

virtual

Set view color.

◆ setDrawValue()

virtual void df::ViewObject::setDrawValue ( bool new_draw_value = true )

virtual

Set true to draw value with display string.

◆ setLocation()

virtual void df::ViewObject::setLocation ( ViewObjectLocation new_location )

virtual

Set general location of ViewObject on screen.

◆ setPosition()

virtual int df::ViewObject::setPosition ( Vector new_pos )

overridevirtual

Set position of ViewObject, with setting "location" to UNDEFINED.

Reimplemented from df::Object.

◆ setValue()

virtual void df::ViewObject::setValue ( int new_value )

virtual

Set view value.

◆ setViewString()

virtual void df::ViewObject::setViewString ( std::string new_view_string )

virtual

Set view display string.

◆ toString()

std::string df::ViewObject::toString ( ) const

Return base attributes as string.

Member Data Documentation

◆ m_border

bool df::ViewObject::m_border

private

True if border around display.

◆ m_color

Color df::ViewObject::m_color

private

Color for text (and border).

◆ m_draw_value

bool df::ViewObject::m_draw_value

private

True if should draw value.

◆ m_location

ViewObjectLocation df::ViewObject::m_location

private

Location of ViewObject.

◆ m_value

int df::ViewObject::m_value

private

Value displayed (e.g., points).

◆ m_view_string

std::string df::ViewObject::m_view_string

private

Label for value (e.g., "Points").

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ViewObject()

Member Function Documentation

◆ deserialize()

◆ draw()

◆ eventHandler()

◆ getBorder()

◆ getColor()

◆ getDrawValue()

◆ getLocation()

◆ getValue()

◆ getViewString()

◆ operator==()

◆ serialize()

◆ setBorder()

◆ setColor()

◆ setDrawValue()

◆ setLocation()

◆ setPosition()

◆ setValue()

◆ setViewString()

◆ toString()

Member Data Documentation

◆ m_border

◆ m_color

◆ m_draw_value

◆ m_location

◆ m_value

◆ m_view_string