Banuba SDK
All Classes Files Functions Properties Macros
Instance Methods | List of all members
BNBScene Class Reference

A class representing a displayable scene. More...

#import <BNBScene.h>

Inheritance diagram for BNBScene:

Instance Methods

(void) - setName:
 Set a new name for a scene. More...
 
(nonnull NSString *) - getName
 Get a scene name. More...
 
(nullable BNBEntity *) - getRoot
 Get the root of entities hierarchy. More...
 
(nullable BNBAssetManager *) - getAssetManager
 Get the AssetManager of a current scene. More...
 
(void) - addLayer:
 
(nonnull NSArray< BNBLayer * > *) - getLayers
 
(nonnull NSArray< BNBComponent * > *) - getComponents:
 Get all components present in this scene of specified type. More...
 
(nullable BNBLayer *) - getLayer:
 Return first found layer with name layerName or NULL if such layer doesn't exist. More...
 
(void) - removeLayer:
 
(void) - setRenderList:
 
(nullable BNBRenderList *) - getRenderList
 
(void) - clearRenderList
 
(nullable BNBCamera *) - getCamera
 
(void) - enableRecognizerFeature:
 
(void) - disableRecognizerFeature:
 
(void) - addFeatureParam:params:
 
(void) - addEffectEvent:params:
 
(BNBTriggerStatusType) - getTriggerStatus:
 
(nullable BNBEntity *) - createEntity:
 
(int64_t) - getNativeContext
 
(int32_t) - getSurfaceWidth
 
(int32_t) - getSurfaceHeight
 
(nullable BNBParameter *) - findGlobalMaterialParameter:
 find global material parameter by name More...
 

Detailed Description

A class representing a displayable scene.

Aggregates in one place the hierarchy of Entities with their Components, AssetManager and RenderList and makes it work all together.

Definition at line 30 of file BNBScene.h.

Method Documentation

◆ addEffectEvent:params:

- (void) addEffectEvent: (nonnull NSString *)  name
params: (nonnull NSDictionary< NSString *, NSString * > *)  params 

◆ addFeatureParam:params:

- (void) addFeatureParam: (BNBFeatureId)  feature
params: (nonnull NSArray< BNBFeatureParameter * > *)  params 

◆ addLayer:

- (void) addLayer: (nullable BNBLayer *)  layer

◆ clearRenderList

- (void) clearRenderList

◆ createEntity:

- (nullable BNBEntity *) createEntity: (nonnull NSString *)  name

◆ disableRecognizerFeature:

- (void) disableRecognizerFeature: (BNBFeatureId)  feature

◆ enableRecognizerFeature:

- (void) enableRecognizerFeature: (BNBFeatureId)  feature

◆ findGlobalMaterialParameter:

- (nullable BNBParameter *) findGlobalMaterialParameter: (nonnull NSString *)  name

find global material parameter by name

Parameters
name(string)
Returns
parameter (parameter) or null

◆ getAssetManager

- (nullable BNBAssetManager *) getAssetManager

Get the AssetManager of a current scene.

It always exists.

◆ getCamera

- (nullable BNBCamera *) getCamera

◆ getComponents:

- (nonnull NSArray<BNBComponent *> *) getComponents: (BNBComponentType)  type

Get all components present in this scene of specified type.

◆ getLayer:

- (nullable BNBLayer *) getLayer: (nonnull NSString *)  layerName

Return first found layer with name layerName or NULL if such layer doesn't exist.

◆ getLayers

- (nonnull NSArray<BNBLayer *> *) getLayers

◆ getName

- (nonnull NSString *) getName

Get a scene name.

◆ getNativeContext

- (int64_t) getNativeContext

◆ getRenderList

- (nullable BNBRenderList *) getRenderList

◆ getRoot

- (nullable BNBEntity *) getRoot

Get the root of entities hierarchy.

It always exists and has a name "Root".

◆ getSurfaceHeight

- (int32_t) getSurfaceHeight

◆ getSurfaceWidth

- (int32_t) getSurfaceWidth

◆ getTriggerStatus:

- (BNBTriggerStatusType) getTriggerStatus: (BNBTriggerType)  trigger

◆ removeLayer:

- (void) removeLayer: (nullable BNBLayer *)  layer

◆ setName:

- (void) setName: (nonnull NSString *)  name

Set a new name for a scene.

The name could be empty.

◆ setRenderList:

- (void) setRenderList: (nullable BNBRenderList *)  renderList

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