BlamWorldObject_PrimitiveCylinder Class Reference

#include <world_objects.h>

Inheritance diagram for BlamWorldObject_PrimitiveCylinder:

Collaboration diagram for BlamWorldObject_PrimitiveCylinder:

Public Member Functions
	BlamWorldObject_PrimitiveCylinder (BlamWorldState *_world)
	BlamWorldObject_PrimitiveCylinder (BlamWorldObject *_parent)
void	Render (float delta) override
	Renders the object to the screen. More...
void	ShowImGuiEditControls () override
Public Member Functions inherited from BlamWorldObject_Primitive
	BlamWorldObject_Primitive (BlamWorldObjectType _type, BlamWorldState *_world)
	Creates a new primitive world object. More...
	BlamWorldObject_Primitive (BlamWorldObjectType _type, BlamWorldObject *_parent)
	~BlamWorldObject_Primitive ()
void	SetCustomDatabablock (Ogre::HlmsDatablock *datablock, bool wireframe)
void	MarkForRebuild ()
void	SetDepthCheckEnabled (bool enable)
void	SetQueryMask (uint32_t mask)
uint32_t	GetQueryMask () override
BlamOrientedBoundingBox	GetWorldOBB () override
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)
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)
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)

Public Attributes
float	radius_0 = 1.0f
	The radius of the primitive. Only used in cylinders. More...
float	radius_1 = 1.0f
	A secondary radius of the primitive. Only used in cylinders. More...
int	resolution = 5
	The level of detail to use for the primitive. Only used in cylinders. More...
int	lines = 5
Public Attributes inherited from BlamWorldObject_Primitive
Ogre::ManualObject *	manual_object = nullptr
Ogre::HlmsDatablock *	datablock = nullptr
Ogre::HlmsDatablock *	datablock_wireframe = nullptr
BlamColor	color = BlamColor(255, 255, 255)
BlamColor	color_wireframe = BlamColor(255, 255, 255)
Blam3DPrimitiveRenderMode	render_mode = Blam3DPrimitiveRenderMode::Solid
bool	show_backfaces = false
bool	cast_shadows = true
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

Additional Inherited Members
Protected Attributes inherited from BlamWorldObject_Primitive
ManualMesh *	manual_mesh = nullptr
bool	custom_datablock = false
bool	custom_wireframe_datablock = false

Constructor & Destructor Documentation

BlamWorldObject_PrimitiveCylinder() [1/2]

BlamWorldObject_PrimitiveCylinder::BlamWorldObject_PrimitiveCylinder

(

BlamWorldState *

_world

)

BlamWorldObject_PrimitiveCylinder() [2/2]

BlamWorldObject_PrimitiveCylinder::BlamWorldObject_PrimitiveCylinder

(

BlamWorldObject *

_parent

)

Member Function Documentation

Render()

void BlamWorldObject_PrimitiveCylinder::Render ( float  delta )

overridevirtual

Renders the object to the screen.

Reimplemented from BlamWorldObject_Primitive.

Here is the call graph for this function:

ShowImGuiEditControls()

void BlamWorldObject_PrimitiveCylinder::ShowImGuiEditControls ( )

overridevirtual

Reimplemented from BlamWorldObject_Primitive.

Here is the call graph for this function:

Member Data Documentation

lines

int BlamWorldObject_PrimitiveCylinder::lines = 5

radius_0

float BlamWorldObject_PrimitiveCylinder::radius_0 = 1.0f

The radius of the primitive. Only used in cylinders.

radius_1

float BlamWorldObject_PrimitiveCylinder::radius_1 = 1.0f

A secondary radius of the primitive. Only used in cylinders.

resolution

int BlamWorldObject_PrimitiveCylinder::resolution = 5

The level of detail to use for the primitive. Only used in cylinders.

---

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

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