BlamWorldObject_Gizmo Class Reference

Class representing a gizmo world object. More...

#include <world_objects.h>

Inheritance diagram for BlamWorldObject_Gizmo:

Collaboration diagram for BlamWorldObject_Gizmo:

Public Member Functions
	BlamWorldObject_Gizmo (BlamWorldState *_world, BlamWorldObjectType _type)
	BlamWorldObject_Gizmo (BlamWorldObject *_parent, BlamWorldObjectType _type)
virtual void	Render (float delta)
	Renders the object to the screen. More...
virtual void	Update ()=0
virtual void	Rebuild ()=0
void	MarkForUpdate ()
void	MarkForRebuild ()
Public Member Functions inherited from BlamWorldObject
	BlamWorldObject (BlamWorldState *_world, BlamWorldObjectType _type)
	Creates a new world object. More...
	BlamWorldObject (BlamWorldObject *_parent, BlamWorldObjectType _type)
virtual	~BlamWorldObject ()
virtual void	Tick (int tick, int total_ticks)
virtual void	ShowImGuiEditControls ()
uint64_t	GetID ()
Ogre::SceneNode *	GetParentSceneNode ()
BlamVector3	GetRotation ()
void	SetRotation (BlamVector3 _rotation, bool local_axes=true)
void	SetRotation (float x, float y, float z, bool local_axes=true)
void	SetRotation (BlamAxis axis, float amount, bool local_axes=true)
BlamVector3	GetAbsolutePosition ()
BlamVector3	GetPosition ()
void	SetPosition (BlamVector3 position)
void	SetPosition (float x, float y, float z)
BlamVector3	GetScale ()
void	SetScale (BlamVector3 scale)
void	SetScale (float x, float y, float z)
BlamVector3	GetScaleModifier ()
void	SetScaleModifier (BlamVector3 scale)
void	SetScaleModifier (float x, float y, float z)
bool	IsHidden ()
bool	GetHidden ()
void	SetHidden (bool hidden)
std::string	GetName ()
void	SetName (std::string name)
void	Translate (BlamVector3 offset, BlamTransformSpace transform_space=BlamTransformSpace::Parent)
void	Rotate (BlamVector3 axis, float rotation_amount, BlamTransformSpace transform_space=BlamTransformSpace::Parent)
BlamVector3	GetDirection ()
virtual void	OnMouseHoverEnter ()
virtual void	OnMouseHoverExit ()
virtual void	OnMouseMove (MouseMoveEvent *event)
virtual void	OnMouseClick (MouseClickEvent *event)
virtual void	OnMouseUnclick (MouseUnclickEvent *event)
virtual uint32_t	GetQueryMask ()
virtual BlamOrientedBoundingBox	GetWorldOBB ()
void	CreateSceneNode ()
void	SetShaderParameter (std::string id, float value)
void	SetShaderParameter (std::string id, BlamVector2 value)
void	SetShaderParameter (std::string id, BlamVector3 value)
void	SetShaderParameter (std::string id, BlamVector4 value)
float	GetShaderParameterFloat (std::string id)
BlamVector2	GetShaderParameterVector2 (std::string id)
BlamVector3	GetShaderParameterVector3 (std::string id)
BlamVector4	GetShaderParameterVector4 (std::string id)

Protected Attributes
bool	needs_update = true
bool	needs_rebuild = true
bgfx::VertexBufferHandle	vb = { bgfx::kInvalidHandle }
bgfx::IndexBufferHandle	ib = { bgfx::kInvalidHandle }
bgfx::VertexLayout	vl

Additional Inherited Members
Public Attributes inherited from BlamWorldObject
uint64_t	id = 0
	A unique identifier for this object. Used to identify objects during runtime. More...
std::string	description = ""
	An optional description of this object. More...
int	editor_folder_id = 0
	The editor folder that this object exists within. Only used within the editing kit. More...
bool	disable_culling = false
uint64_t	state_flags = BGFX_STATE_DEFAULT | BGFX_STATE_CULL_CCW | BGFX_STATE_BLEND_ALPHA
BlamWorldState *	world = nullptr
	The world state this object belongs to. More...
BlamWorldObject *	parent = nullptr
BlamWorldObjectType	type = BlamWorldObjectType::Unspecified
	The type of this world object. More...
Ogre::SceneNode *	scene_node = nullptr

Detailed Description

Class representing a gizmo world object.

Gizmos (or Editor Gizmos) are special world objects that are used to provide editing/debugging functionality in-engine. Typical examples of gizmos could be object transform gizmos (used to move objects in the world), bounding boxes, grids, etc.

For all possible primitive types, see #Blam3DPrimitiveType.

Constructor & Destructor Documentation

BlamWorldObject_Gizmo() [1/2]

BlamWorldObject_Gizmo::BlamWorldObject_Gizmo ( BlamWorldState *  _world, BlamWorldObjectType  _type  )

inline

BlamWorldObject_Gizmo() [2/2]

BlamWorldObject_Gizmo::BlamWorldObject_Gizmo ( BlamWorldObject *  _parent, BlamWorldObjectType  _type  )

inline

Member Function Documentation

MarkForRebuild()

void BlamWorldObject_Gizmo::MarkForRebuild

(

)

Here is the caller graph for this function:

MarkForUpdate()

void BlamWorldObject_Gizmo::MarkForUpdate

(

)

Here is the caller graph for this function:

Rebuild()

virtual void BlamWorldObject_Gizmo::Rebuild ( )

pure virtual

Implemented in BlamWorldObject_Gizmo3DCursor, BlamWorldObject_GizmoTransform, and BlamWorldObject_GizmoGrid.

Here is the caller graph for this function:

Render()

void BlamWorldObject_Gizmo::Render ( float  delta )

virtual

Renders the object to the screen.

Reimplemented from BlamWorldObject.

Reimplemented in BlamWorldObject_Gizmo3DCursor, BlamWorldObject_GizmoTransform, and BlamWorldObject_GizmoGrid.

Here is the call graph for this function:

Update()

virtual void BlamWorldObject_Gizmo::Update ( )

pure virtual

Implemented in BlamWorldObject_Gizmo3DCursor, BlamWorldObject_GizmoTransform, and BlamWorldObject_GizmoGrid.

Here is the caller graph for this function:

Member Data Documentation

ib

bgfx::IndexBufferHandle BlamWorldObject_Gizmo::ib = { bgfx::kInvalidHandle }

protected

needs_rebuild

bool BlamWorldObject_Gizmo::needs_rebuild = true

protected

needs_update

bool BlamWorldObject_Gizmo::needs_update = true

protected

vb

bgfx::VertexBufferHandle BlamWorldObject_Gizmo::vb = { bgfx::kInvalidHandle }

protected

vl

bgfx::VertexLayout BlamWorldObject_Gizmo::vl

protected

---

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

• blam/api/v1/types/world_objects.h
• blam/api/v1/types/world/BlamWorldObject_Gizmo.cpp