You.i Engine
CYIMask Class Reference

Detailed Description

Adds a masking effect to a scene node.

#include <renderer/YiMask.h>

Public Member Functions

 CYIMask ()
 
virtual ~CYIMask ()
 
void SetImage (const std::shared_ptr< CYIAssetTexture > &pTextureAsset)
 
const std::shared_ptr< CYIMesh > & GetMesh () const
 
const std::shared_ptr< CYIMaterial > & GetMaterial () const
 
void SetTransform (const glm::mat4 &maskTransform)
 
const glm::mat4 & GetTransform () const
 
void CalculateModelMatrix (const glm::mat4 &worldTransform)
 
const glm::mat4 & GetModelMatrix () const
 

Protected Attributes

std::shared_ptr< CYIMeshm_pMesh
 
std::shared_ptr< CYIMaterialm_pMaterial
 
glm::mat4 m_ModelMatrix
 
glm::mat4 m_Transform
 

Constructor & Destructor Documentation

◆ CYIMask()

CYIMask::CYIMask ( )

◆ ~CYIMask()

virtual CYIMask::~CYIMask ( )
virtual

Member Function Documentation

◆ CalculateModelMatrix()

void CYIMask::CalculateModelMatrix ( const glm::mat4 &  worldTransform)

◆ GetMaterial()

const std::shared_ptr<CYIMaterial>& CYIMask::GetMaterial ( ) const

Get the material represented by this mask.

◆ GetMesh()

const std::shared_ptr<CYIMesh>& CYIMask::GetMesh ( ) const

Get the mesh data prepresented by this mask.

◆ GetModelMatrix()

const glm::mat4& CYIMask::GetModelMatrix ( ) const

◆ GetTransform()

const glm::mat4& CYIMask::GetTransform ( ) const

◆ SetImage()

void CYIMask::SetImage ( const std::shared_ptr< CYIAssetTexture > &  pTextureAsset)

Initialize mask with the software buffer associated with maskImage.

◆ SetTransform()

void CYIMask::SetTransform ( const glm::mat4 &  maskTransform)

Member Data Documentation

◆ m_ModelMatrix

glm::mat4 CYIMask::m_ModelMatrix
protected

The mask's current model matrix

◆ m_pMaterial

std::shared_ptr<CYIMaterial> CYIMask::m_pMaterial
protected

The mask's material, if any

◆ m_pMesh

std::shared_ptr<CYIMesh> CYIMask::m_pMesh
protected

The mask's mesh, if any

◆ m_Transform

glm::mat4 CYIMask::m_Transform
protected

The mask's transform


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