#include <CUObjNode.h>

Inheritance diagram for cugl::scene3::ObjNode:

Public Member Functions
	ObjNode ()

	~ObjNode ()

virtual void	dispose () override

bool	initWithModel (const std::shared_ptr< ObjModel > &model)

bool	initWithData (const AssetManager *manager, const std::shared_ptr< JsonValue > &json) override

virtual std::shared_ptr< SceneNode >	copy (const std::shared_ptr< SceneNode > &dst) const override

std::shared_ptr< SceneNode >	clone () const

std::shared_ptr< ObjModel >	getModel () const

void	setModel (const std::shared_ptr< ObjModel > &model)

std::shared_ptr< Material >	getMaterial () const

void	setMaterial (const std::shared_ptr< Material > &material)

Public Member Functions inherited from cugl::scene3::SceneNode
	SceneNode ()

	~SceneNode ()

virtual void	dispose ()

virtual bool	init ()

virtual bool	initWithPosition (const Vec3 pos)

bool	initWithPosition (float x, float y, float z)

virtual bool	initWithAnchor (const Vec3 anchor)

bool	initWithAnchor (float x, float y, float z)

virtual bool	initWithAnchor (const Vec3 pos, const Vec3 anchor)

virtual bool	initWithData (const AssetManager *manager, const std::shared_ptr< JsonValue > &json)

virtual std::shared_ptr< SceneNode >	copy (const std::shared_ptr< SceneNode > &dst) const

unsigned int	getTag () const

void	setTag (unsigned int tag)

const std::string	getName () const

void	setName (const std::string name)

const std::string	getClassName () const

CUEnum	getBatchKey () const

void	setBatchKey (CUEnum key)

virtual std::string	toString (bool verbose=false) const

	operator std::string () const

const Vec3	getPosition () const

void	setPosition (const Vec3 position)

void	setPosition (float x, float y, float z)

Vec3	getWorldPosition () const

void	setAnchor (const Vec3 anchor)

void	setAnchor (float x, float y, float z)

const Vec3	getAnchor () const

bool	isVisible () const

void	setVisible (bool visible)

cugl::Vec3	getScale () const

void	setScale (float scale)

void	setScale (const cugl::Vec3 scale)

cugl::Quaternion	getRotation () const

void	setRotation (cugl::Quaternion rot)

const Mat4 &	getModelMatrix () const

const Mat4 &	getNodeToParentTransform () const

Mat4	getParentToNodeTransform () const

virtual Mat4	getNodeToWorldTransform () const

Mat4	getWorldToNodeTransform () const

Vec3	screenToNodeCoords (const Vec2 screenPoint) const

Vec3	worldToNodeCoords (const Vec3 worldPoint) const

Vec2	nodeToScreenCoords (const Vec3 nodePoint) const

Vec3	nodeToWorldCoords (const Vec3 nodePoint) const

Vec3	parentToNodeCoords (const Vec3 parentPoint) const

Vec3	nodeToParentCoords (const Vec3 nodePoint) const

size_t	getChildCount () const

std::shared_ptr< SceneNode >	getChild (unsigned int pos)

const std::shared_ptr< SceneNode > &	getChild (unsigned int pos) const

template<typename T >
std::shared_ptr< T >	getChild (unsigned int pos) const

std::shared_ptr< SceneNode >	getChildByTag (unsigned int tag) const

template<typename T >
std::shared_ptr< T >	getChildByTag (unsigned int tag) const

std::shared_ptr< SceneNode >	getChildByName (const std::string name) const

template<typename T >
std::shared_ptr< T >	getChildByName (const std::string name) const

std::vector< std::shared_ptr< SceneNode > >	getChildren ()

const std::vector< std::shared_ptr< SceneNode > > &	getChildren () const

void	addChild (const std::shared_ptr< SceneNode > &child)

void	addChildWithTag (const std::shared_ptr< SceneNode > &child, unsigned int tag)

void	addChildWithName (const std::shared_ptr< SceneNode > &child, const std::string name)

void	swapChild (const std::shared_ptr< SceneNode > &child1, const std::shared_ptr< SceneNode > &child2, bool inherit=false)

SceneNode *	getParent ()

const SceneNode *	getParent () const

Scene3 *	getScene ()

const Scene3 *	getScene () const

void	removeFromParent ()

virtual void	removeChild (unsigned int pos)

void	removeChild (const std::shared_ptr< SceneNode > &child)

void	removeChildByTag (unsigned int tag)

void	removeChildByName (const std::string name)

virtual void	removeAllChildren ()

Static Public Member Functions
static std::shared_ptr< ObjNode >	allocWithModel (const std::shared_ptr< ObjModel > &model)

static std::shared_ptr< ObjNode >	allocWithData (const AssetManager *manager, const std::shared_ptr< JsonValue > &json)

Static Public Member Functions inherited from cugl::scene3::SceneNode
static std::shared_ptr< SceneNode >	alloc ()

static std::shared_ptr< SceneNode >	allocWithPosition (const Vec3 pos)

static std::shared_ptr< SceneNode >	allocWithPosition (float x, float y, float z)

static std::shared_ptr< SceneNode >	allocWithAnchor (const Vec3 anchor)

static std::shared_ptr< SceneNode >	allocWithAnchor (float x, float y, float z)

static std::shared_ptr< SceneNode >	allocWithAnchor (const Vec3 pos, const Vec3 anchor)

static std::shared_ptr< SceneNode >	allocWithData (const AssetManager *manager, const std::shared_ptr< JsonValue > &json)

Public Attributes
std::shared_ptr< ObjModel >	_model

std::shared_ptr< Material >	_material

Additional Inherited Members
Protected Attributes inherited from cugl::scene3::SceneNode
unsigned int	_tag

std::string	_name

size_t	_hashOfName

std::string	_classname

bool	_isVisible

cugl::Vec3	_position

cugl::Vec3	_anchor

cugl::Vec3	_scale

cugl::Quaternion	_rotate

Mat4	_modelmat

std::vector< std::shared_ptr< SceneNode > >	_children

SceneNode *	_parent

Scene3 *	_graph

int	_childOffset

CUEnum	_batchkey

std::shared_ptr< JsonValue >	_json

Detailed Description

This class represents an OBJ model in a 3d scene graph.

OBJ models are assets, like graphics::Texture objects. By themselves, they do not have enough information to display them on the screen. They need a position and orientation. That is the purpose of this class. It combines an OBJ model with position/orientation information so that it can be drawn on the screen.

If you wish to break up an OBJ model into multiple nodes (for the purpose of animation), use ObjModel#getSubModel to extract the individual components before making the nodes.

Constructor & Destructor Documentation

◆ ObjNode()

cugl::scene3::ObjNode::ObjNode ( )

Creates an uninitialized node.

You must initialize this model before use.

NEVER USE A CONSTRUCTOR WITH NEW. If you want to allocate a model on the heap, use one of the static constructors instead.

◆ ~ObjNode()

cugl::scene3::ObjNode::~ObjNode ( )

inline

Deletes this node, disposing all resources

Member Function Documentation

◆ allocWithData()

static std::shared_ptr< ObjNode > cugl::scene3::ObjNode::allocWithData	(	const AssetManager *	manager,
		const std::shared_ptr< JsonValue > &	json
	)

inlinestatic

Returns a newly allocated node with the given JSON specification.

This initializer is designed to receive the "data" object from the JSON passed to Scene3Loader. This JSON format supports all of the attribute values of its parent class. In addition, it supports the following additional attribute:

 "model":     A string with the name of a previously loaded OBJ asset

While this attribute is technically optional, not specifying means that nothing is drawn.

Parameters

manager	The asset manager handling this asset
json	The JSON object specifying the node

Returns: a newly allocated node with the given JSON specification.

◆ allocWithModel()

static std::shared_ptr< ObjNode > cugl::scene3::ObjNode::allocWithModel ( const std::shared_ptr< ObjModel > & model )

inlinestatic

Returns a newly allocated node with the given model

This node will keep a reference to the given model, but it will have its own model matrix. Therefore it is possible for multiple nodes to share the same model.

Parameters

model The OBJ model

Returns: a newly allocated node with the given model

◆ clone()

std::shared_ptr< SceneNode > cugl::scene3::ObjNode::clone ( ) const

Returns a shallow copy of this node.

The nodes will share the OBJ models, but each have their own model matrix.

No children from this model are copied, and no children of dst are modified. In addition, the parents of both node are unchanged. However, all other attributes of this node are copied.

Returns: a shallow copy of this node.

◆ copy()

virtual std::shared_ptr< SceneNode > cugl::scene3::ObjNode::copy ( const std::shared_ptr< SceneNode > & dst ) const

overridevirtual

Performs a shallow copy of this node into dst.

The nodes will share the OBJ models, but each have their own model matrix.

No children from this model are copied, and no children of dst are modified. In addition, the parents of both node are unchanged. However, all other attributes of this node are copied.

Parameters

dst	The node to copy into

Returns: a reference to dst for chaining.

Reimplemented from cugl::scene3::SceneNode.

◆ dispose()

virtual void cugl::scene3::ObjNode::dispose ( )

overridevirtual

Disposes all of the resources used by this node.

A disposed node can be safely reinitialized. Any children owned by this node will be released. They will be deleted if no other object owns them.

It is unsafe to call this on a node that is still currently inside of a scene graph.

Reimplemented from cugl::scene3::SceneNode.

◆ getMaterial()

std::shared_ptr< Material > cugl::scene3::ObjNode::getMaterial ( ) const

inline

Returns the default material for this model reference.

This material will be applied to any surface that does not already have a material. Otherwise, it is ignored.

Returns: the default material for this model reference.

◆ getModel()

std::shared_ptr< ObjModel > cugl::scene3::ObjNode::getModel ( ) const

inline

Returns the model associated with this node.

If this value is nullptr, nothing will be drawn for this node.

Returns: the model associated with this node.

◆ initWithData()

bool cugl::scene3::ObjNode::initWithData	(	const AssetManager *	manager,
		const std::shared_ptr< JsonValue > &	json
	)

overridevirtual

Initializes a node with the given JSON specification.

This initializer is designed to receive the "data" object from the JSON passed to Scene3Loader. This JSON format supports all of the attribute values of its parent class. In addition, it supports the following additional attribute:

 "model":     A string with the name of a previously loaded OBJ asset

While this attribute is technically optional, not specifying means that nothing is drawn.

Parameters

manager	The asset manager handling this asset
json	The JSON object specifying the node

Returns: true if initialization was successful.

Reimplemented from cugl::scene3::SceneNode.

◆ initWithModel()

bool cugl::scene3::ObjNode::initWithModel ( const std::shared_ptr< ObjModel > & model )

Initializes this node with the given model

This node will keep a reference to the given model, but it will have its own model matrix. Therefore it is possible for multiple nodes to share the same model.

Parameters

model The OBJ model

Returns: true if initialization was successful.

◆ setMaterial()

void cugl::scene3::ObjNode::setMaterial ( const std::shared_ptr< Material > & material )

inline

Sets the default material for this model reference.

This material will be applied to any surface that does not already have a material. Otherwise, it is ignored.

Parameters

material The default material for this model reference.

◆ setModel()

void cugl::scene3::ObjNode::setModel ( const std::shared_ptr< ObjModel > & model )

inline

Sets the model associated with this node.

If this value is nullptr, nothing will be drawn for this node.

Parameters

model The model associated with this node.

Member Data Documentation

◆ _material

std::shared_ptr<Material> cugl::scene3::ObjNode::_material

A material to apply as a default

◆ _model

std::shared_ptr<ObjModel> cugl::scene3::ObjNode::_model

The model associated with this node

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

/Users/wmwhite/Developer/CUGL/include/cugl/scene3/CUObjNode.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ObjNode()

◆ ~ObjNode()

Member Function Documentation

◆ allocWithData()

◆ allocWithModel()

◆ clone()

◆ copy()

◆ dispose()

◆ getMaterial()

◆ getModel()

◆ initWithData()

◆ initWithModel()

◆ setMaterial()

◆ setModel()

Member Data Documentation

◆ _material

◆ _model