Class containing data for a Line object. More...

#include <render_stack.h>

Inheritance diagram for BlamRendering::RenderStack::Line:

Public Member Functions
	Line ()
	Sets the stack type, default starting/ending points, and default zone color. More...

	~Line ()
	Empty destructor. More...

void	Draw ()
	Draws the stack object. More...

void	ShowImPropertyEditor ()
	Shows a set of ImGUI properties associated with the object. More...

void	PokeLineTranslation ()
	Pokes the line start/end points to match the coordinates/area. More...

void	SetThickness (float new_thickness)
	Sets the thickness of the line. More...

Public Member Functions inherited from BlamRendering::RenderStack::StackObjectBase
	StackObjectBase ()
	Sets default values and provides a default ID to be used if none is provided. More...

	~StackObjectBase ()
	Empty destructor. More...

virtual void	HandleResize ()
	Called upon window resize events. More...

void	SetArea (float new_area[4])
	Sets the area of the object. More...

void	SetArea (float top, float bottom, float left, float right)
	Sets the area of the object. More...

void	SetArea (D2D1_RECT_F new_area)
	Sets the area of the object. More...

void	SetColor (float new_color[3])
	Sets the color of the object. More...

void	SetColor (float r, float g, float b)
	Sets the color of the object. More...

void	SetColor (float r, float g, float b, float a)
	Sets the color of the object. More...

void	SetColor (D2D1::ColorF color)
	Sets the color of the object. More...

void	SetZOrder (int z)
	Sets the Z-Order of the object. More...

void	SetTranslation (float new_x, float new_y)
	Sets the translation of the object. More...

void	PokeTranslation ()
	Updates the area of the object to account for any x/y coordinate changes. More...

void	SetSize (float new_width, float new_height)
	Sets the size of the object. More...

void	PokeSize ()
	Updates the area of the object to account for any width/height changes. More...

void	ValidateSizeAndTranslation ()
	Validates X/Y coordinates and Width/Height sizes after the area has been modified. More...

std::string	GetType ()
	Retrieves the type of item that this stack object is. More...

std::string	GetDrawModeLabel ()
	Retrieves the current drawing mode of the object. More...

Public Attributes
D2D1_POINT_2F	start_point
	The starting point of the line. More...

D2D1_POINT_2F	end_point
	The ending point of the line. More...

float	thickness = 1
	The line thickness. More...

bool	show_zone = false
	Whether or not to show the line area. More...

D2D1_COLOR_F	zone_color
	The color of the line area border. More...

float	zone_thickness = 1
	The thickness of the line area border. More...

Public Attributes inherited from BlamRendering::RenderStack::StackObjectBase
D2D1_RECT_F	area
	The area of the object. More...

D2D1_COLOR_F	color
	The color of the object. More...

int	z_order = 0
	The Z-Order of the object. More...

StackType	type_label = STACKTYPE_GENERIC
	The type of the object. More...

StackItemDrawMode	draw_mode = DEFAULT_DRAWMODE
	The drawing mode of the object. More...

bool	visible = true
	Whether or not the object is visible. More...

float	x = 0
	The X coordinate of the object. More...

float	y = 0
	The Y coordinate of the object. More...

float	width = 100
	The width of the object. More...

float	height = 100
	The height of the object. More...

std::string	unique_id = ""
	The unique ID of this object. More...

Detailed Description

Class containing data for a Line object.

Constructor & Destructor Documentation

◆ Line()

BlamRendering::RenderStack::Line::Line ( )

inline

Sets the stack type, default starting/ending points, and default zone color.

◆ ~Line()

BlamRendering::RenderStack::Line::~Line ( )

inline

Empty destructor.

Member Function Documentation

◆ Draw()

void BlamRendering::RenderStack::Line::Draw ( )

virtual

Draws the stack object.

Specific functionality may vary depending on the type of object.

Reimplemented from BlamRendering::RenderStack::StackObjectBase.

◆ PokeLineTranslation()

void BlamRendering::RenderStack::Line::PokeLineTranslation ( )

Pokes the line start/end points to match the coordinates/area.

◆ SetThickness()

void BlamRendering::RenderStack::Line::SetThickness ( float new_thickness )

Sets the thickness of the line.

Parameters

new_thickness - The new thickness of the line.

◆ ShowImPropertyEditor()

void BlamRendering::RenderStack::Line::ShowImPropertyEditor ( )

virtual

Shows a set of ImGUI properties associated with the object.

This will call functions to draw only the property controls for the item, and nothing else. The window/container for the properties must be handled externally.

Reimplemented from BlamRendering::RenderStack::StackObjectBase.

Member Data Documentation

◆ end_point

D2D1_POINT_2F BlamRendering::RenderStack::Line::end_point

The ending point of the line.

◆ show_zone

bool BlamRendering::RenderStack::Line::show_zone = false

Whether or not to show the line area.

◆ start_point

D2D1_POINT_2F BlamRendering::RenderStack::Line::start_point

The starting point of the line.

◆ thickness

float BlamRendering::RenderStack::Line::thickness = 1

The line thickness.

◆ zone_color

D2D1_COLOR_F BlamRendering::RenderStack::Line::zone_color

The color of the line area border.

◆ zone_thickness

float BlamRendering::RenderStack::Line::zone_thickness = 1

The thickness of the line area border.

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

blam/components/rendering/directx11/render_stack/render_stack.h
blam/components/rendering/directx11/render_stack/stack_types/Line.cpp

Public Member Functions

Public Attributes