Project

General

Profile

SO3Engine
SO3::SSky::SkyComponent Class Referenceabstract

#include <SO3Sky.h>

Inheritance diagram for SO3::SSky::SkyComponent:
SO3::SSky::CloudLayered SO3::SSky::CloudVolumetric

Public Member Functions

 SkyComponent (SSky *parentSkyInstance, const SkyComponentType &component)
 
virtual ~SkyComponent ()
 
bool GetEnabled ()
 
void SetEnabled (const bool &enable)
 
virtual void SetEnableImpl (const bool &enableComponent)
 
virtual void UnregisterCamera (Ogre::Camera *cam)
 
SkyComponentType GetType ()
 
virtual void Update (const Ogre::Real &updateTime)=0
 

Protected Attributes

SSkyparentSky
 

Detailed Description

Abstract class that define a cloud.

Remarks
Do not use directly, must be inherited!

Definition at line 70 of file SO3Sky.h.

Constructor & Destructor Documentation

◆ SkyComponent()

SO3::SSky::SkyComponent::SkyComponent ( SSky parentSkyInstance,
const SkyComponentType component 
)

Definition at line 422 of file SO3Sky.cpp.

◆ ~SkyComponent()

SO3::SSky::SkyComponent::~SkyComponent ( )
virtual

Definition at line 433 of file SO3Sky.cpp.

Member Function Documentation

◆ GetEnabled()

bool SO3::SSky::SkyComponent::GetEnabled ( )

Enable the cloud system

Definition at line 438 of file SO3Sky.cpp.

◆ GetType()

SSky::SkyComponentType SO3::SSky::SkyComponent::GetType ( )

Definition at line 457 of file SO3Sky.cpp.

◆ SetEnabled()

void SO3::SSky::SkyComponent::SetEnabled ( const bool &  enable)

Disable the cloud system

Definition at line 451 of file SO3Sky.cpp.

◆ SetEnableImpl()

void SO3::SSky::SkyComponent::SetEnableImpl ( const bool &  enableComponent)
virtual

Reimplemented in SO3::SSky::CloudLayered, and SO3::SSky::CloudVolumetric.

Definition at line 443 of file SO3Sky.cpp.

◆ UnregisterCamera()

void SO3::SSky::SkyComponent::UnregisterCamera ( Ogre::Camera *  cam)
virtual

call this before deleteing a camera for Vcloud

Reimplemented in SO3::SSky::CloudVolumetric.

Definition at line 447 of file SO3Sky.cpp.

◆ Update()

virtual void SO3::SSky::SkyComponent::Update ( const Ogre::Real &  updateTime)
pure virtual

Member Data Documentation

◆ parentSky

SSky* SO3::SSky::SkyComponent::parentSky
protected

Definition at line 74 of file SO3Sky.h.


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