Lysa Nodes  0.0
Lysa Nodes — Scene Graph for the Lysa Engine
Public Member Functions | Protected Member Functions | List of all members
MeshInstance Class Reference

Detailed Description

Node that holds a Mesh.

+ Inheritance diagram for MeshInstance:

Public Member Functions

 MeshInstance (const Mesh &mesh, const std::string &name=TypeNames[MESH_INSTANCE])
 
 MeshInstance (const MeshInstance &mi)
 
const auto & getMesh () const
 
const auto & getAABB () const
 
void setSurfaceOverrideMaterial (uint32 surfaceIndex, const Material &material)
 
Material * getSurfaceOverrideMaterial (uint32 surfaceIndex) const
 
void removeSurfaceOverrideMaterial (uint32 surfaceIndex)
 
const Material & getSurfaceMaterial (uint32 surfaceIndex) const
 
void setCastShadows (bool castShadows)
 
auto isCastShadows () const
 
auto & getMeshInstance ()
 
void setVisible (bool visible) override
 
void updateGlobalTransform () override
 
std::shared_ptr< Node > copy () const override
 
void setLuaThis () override
 
- Public Member Functions inherited from Node
 Node (const Node &node)
 
 Node (const std::string &name=TypeNames[NODE], Type type=NODE)
 
virtual ~Node () = default
 
auto getId () const
 
virtual void onReady ()
 
virtual void onEnterScene ()
 
virtual void onExitScene ()
 
virtual void onProcess (const float alpha)
 
virtual void onPhysicsProcess (const float delta)
 
virtual bool onInput (const InputEvent &inputEvent)
 
const float4x4 & getTransform () const
 
void setTransform (const float4x4 &transform)
 
const float4x4 & getTransformGlobal () const
 
virtual void setPosition (const float3 &position)
 
virtual void setPosition (const float x, const float y, const float z)
 
float3 getPosition () const
 
void translate (const float3 &localOffset)
 
void translate (const float x, const float y, const float z)
 
virtual void setPositionGlobal (const float3 &position)
 
virtual void setPositionGlobal (const float x, const float y, const float z)
 
float3 getPositionGlobal () const
 
void rotate (const quaternion &quaternion)
 
void rotateX (float angle)
 
void rotateY (float angle)
 
void rotateZ (float angle)
 
void rotateGlobalX (float angle)
 
void rotateGlobalY (float angle)
 
void rotateGlobalZ (float angle)
 
quaternion getRotation () const
 
quaternion getRotationGlobal () const
 
float3 getRotationEulerAngles () const
 
float3 getRotationEulerAnglesGlobal () const
 
virtual void scale (float scale)
 
void setScale (const float3 &scale)
 
void setRotation (const quaternion &quat)
 
void setRotationGlobal (const quaternion &quat)
 
void setRotation (const float3 &rot)
 
void setRotationX (float angle)
 
void setRotationY (float angle)
 
void setRotationZ (float angle)
 
float getRotationX () const
 
float getRotationY () const
 
float getRotationZ () const
 
float getRotationGlobalX () const
 
float getRotationGlobalY () const
 
float getRotationGlobalZ () const
 
void setRotationGlobalX (float angle)
 
void setRotationGlobalY (float angle)
 
void setRotationGlobalZ (float angle)
 
float3 getScale () const
 
float3 getScaleGlobal () const
 
template<typename T = Node>
const std::shared_ptr< T > & addChild (const std::shared_ptr< T > &child, bool async=false)
 
template<typename T = Node>
bool removeChild (const std::shared_ptr< T > &child)
 
void removeAllChildren (bool async=false)
 
void lookAt (const float3 &target)
 
template<typename T = Node>
std::list< std::shared_ptr< T > > findAllChildrenByGroup (const std::string &groupName, const bool recursive=true) const
 
const std::list< std::string > & getGroups () const
 
void addToGroup (const std::string &group)
 
void removeFromGroup (const std::string &group)
 
virtual bool isVisible () const
 
bool isInGroup (const std::string &group) const
 
void setProcessMode (const ProcessMode mode)
 
bool isProcessed () const
 
auto getType () const
 
std::string getPath () const
 
void printTree (int tab=0) const
 
std::shared_ptr< Node > duplicate (bool recursiveFilter=false) const
 
float3 toGlobal (const float3 &local) const
 
float3 toLocal (const float3 &global) const
 
float3 getRightVector () const
 
float3 getLeftVector () const
 
float3 getFrontVector () const
 
float3 getBackVector () const
 
float3 getUpVector () const
 
float3 getDownVector () const
 
template<typename T >
bool haveChild (const std::shared_ptr< T > &child, const bool recursive=true) const
 
template<typename T = Node>
std::shared_ptr< T > getChild (const std::string &name) const
 
template<typename T = Node>
std::shared_ptr< T > getChildByPath (const std::string &path) const
 
template<typename T = Node>
std::string getRelativePath (const std::shared_ptr< T > &root) const
 
template<typename T = Node>
std::shared_ptr< T > findFirstChild (const std::string &name) const
 
template<typename T >
std::shared_ptr< T > findFirstChild (const bool recursive=true) const
 
template<typename T >
std::list< std::shared_ptr< T > > findAllChildren (const bool recursive=true) const
 
template<typename T = Node>
std::list< std::shared_ptr< T > > findAllChildren (const std::string &name, const bool recursive=true) const
 
const std::list< std::shared_ptr< Node > > & getChildren ()
 
const std::list< std::shared_ptr< Node > > & getChildren () const
 
void setName (const std::string &nodeName)
 
template<typename T = Node>
std::shared_ptr< T > getSharedPtr ()
 
const std::string & getName () const
 
template<typename T = Scene>
T * getScene () const
 
const auto & getParent () const
 
bool haveParent () const
 
void setLuaThis () override
 

Protected Member Functions

void setProperty (const std::string &property, const std::string &value) override
 

Additional Inherited Members

- Public Types inherited from Node
enum  Type {
  ANIMATION_PLAYER, CAMERA, CHARACTER, COLLISION_AREA,
  COLLISION_OBJECT, DIRECTIONAL_LIGHT, ENVIRONMENT, KINEMATIC_BODY,
  LIGHT, MESH_INSTANCE, NODE, OMNI_LIGHT,
  PHYSICS_BODY, RAYCAST, RIGID_BODY, SKYBOX,
  SPOT_LIGHT, STATIC_BODY, VIEWPORT
}
 Node type. More...
 
- Static Public Member Functions inherited from Node
static std::string sanitizeName (const std::string &name)
 
- Static Public Attributes inherited from Node
static constexpr auto TypeNames
 Display names for each node Type value, indexed by the Type enum. More...
 
- Protected Attributes inherited from Node
float4x4 localTransform {}
 
float4x4 globalTransform {}
 
Scene * scene {nullptr}
 

Constructor & Destructor Documentation

MeshInstance ( const Mesh &  mesh,
const std::string &  name = TypeNames[MESH_INSTANCE] 
)

Constructor

Parameters
meshThe mesh to instance
nameThe name of the node
MeshInstance ( const MeshInstance &  mi)

Copy constructor — creates an independent mesh instance node sharing the same underlying mesh.

Member Function Documentation

std::shared_ptr<Node> copy ( ) const
overridevirtual

Copies the node

Reimplemented from lysa::nodes::Node::copy()

const auto& getAABB ( ) const
inline

Returns the world space axis aligned bounding box

const auto& getMesh ( ) const
inline

Returns the associated Mesh

auto& getMeshInstance ( )
inline

Returns the underlying mesh instance resource

const Material& getSurfaceMaterial ( uint32  surfaceIndex) const

Returns the material for a given surface, original or override

Material* getSurfaceOverrideMaterial ( uint32  surfaceIndex) const

Returns the override material for a specific surface, if any

auto isCastShadows ( ) const
inline

Returns whether the instance casts shadows

void removeSurfaceOverrideMaterial ( uint32  surfaceIndex)

Removes the override material for a specific surface

void setCastShadows ( bool  castShadows)

Sets whether the instance casts shadows

void setLuaThis ( )
override
void setProperty ( const std::string &  property,
const std::string &  value 
)
overrideprotectedvirtual

Sets a node property

Reimplemented from lysa::nodes::Node::setProperty()

void setSurfaceOverrideMaterial ( uint32  surfaceIndex,
const Material &  material 
)

Sets an override material for a specific surface

void setVisible ( bool  visible)
overridevirtual

Sets the visibility of the node

Reimplemented from lysa::nodes::Node::setVisible()

void updateGlobalTransform ( )
overridevirtual

Updates the global transform

Reimplemented from lysa::nodes::Node::updateGlobalTransform()