AppView 0.8.3
AppView3D Class Reference

App View 3D. Starts and renders a 3rd party application. More...

#include <app_view_3d.hpp>

Inheritance diagram for AppView3D:
AppViewConceptImpl< Model3D, AppView3D > AppViewConcept

Public Types

using ConceptClass = AppViewConceptImpl<Model3D, AppView3D>
 

Public Member Functions

MeshSharedPtr getOverrideMesh () const
 Gets the value of OverrideMeshProperty.
 
void onFinishApp (FinishAppMessageArguments &messageArguments)
 
void onNavigateBack (const NavigateBackMessageArguments &messageArguments)
 
void onStartApp (const StartAppMessageArguments &messageArguments)
 
void onUpdateVirtualDisplay (const UpdateVirtualDisplayMessageArguments &messageArguments)
 
void setOverrideMesh (ResourceSharedPtr value)
 Sets the value of OverrideMeshProperty.
 

Static Public Member Functions

static AppView3DSharedPtr create (Domain *domain, string_view name)
 
- Static Public Member Functions inherited from AppViewConceptImpl< Model3D, AppView3D >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from AppViewConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

static PropertyType< ResourceSharedPtr > OverrideMeshProperty
 Overrides the default mesh resource.
 
- Static Public Attributes inherited from AppViewConcept
static PropertyType< string > AppNameProperty
 
static PropertyType< string > VirtualDisplayNameProperty
 
static PropertyType< int > VirtualDisplayWidthProperty
 
static PropertyType< int > VirtualDisplayHeightProperty
 
static PropertyType< int > VirtualDisplayDensityProperty
 
static PropertyType< bool > CanExitAppProperty
 
static PropertyType< ResourceSharedPtr > OverrideMaterialProperty
 
static PropertyType< string > MessageArgumentAppNameProperty
 
static PropertyType< bool > MessageArgumentCanExitAppProperty
 
static PropertyType< int > MessageArgumentVirtualDisplayWidthProperty
 
static PropertyType< int > MessageArgumentVirtualDisplayHeightProperty
 
static PropertyType< int > MessageArgumentVirtualDisplayDensityProperty
 
static MessageType< StartAppMessageArgumentsStartAppMessage
 
static MessageType< FinishAppMessageArgumentsFinishAppMessage
 
static MessageType< NavigateBackMessageArgumentsNavigateBackMessage
 
static MessageType< UpdateVirtualDisplayMessageArgumentsUpdateVirtualDisplayMessage
 
static MessageType< MessageArguments > PauseAppMessage
 
static MessageType< MessageArguments > ResumeAppMessage
 

Protected Member Functions

 AppView3D (Domain *domain, string_view name)
 
bool calculateHitUV (const TouchPoint &touchPoint, Vector2 &outHitUV) override
 
void onAppViewTextureChanged () override
 AppView::onAppViewTextureChanged() implementation.
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged() implementation.
 
void setupMaterialOverride () override
 
void updateMaterial ()
 
void updateMesh ()
 
- Protected Member Functions inherited from AppViewConceptImpl< Model3D, AppView3D >
 AppViewConceptImpl (Domain *domain, string_view name)
 
MaterialSharedPtr getAppViewMaterial ()
 
TextureSharedPtr getAppViewTexture ()
 
void handleFinishAppMessage (FinishAppMessageArguments &messageArguments)
 
void handleNavigateBackMessage (const NavigateBackMessageArguments &messageArguments)
 
void handleStartAppMessage (const StartAppMessageArguments &messageArguments)
 
void handleUpdateVirtualDisplayMessage (const UpdateVirtualDisplayMessageArguments &messageArguments)
 
void initialize ()
 
void onAttached () override
 
void onDetached () override
 
void onFrameAvailable ()
 Kanzi calls this function from the main UI thread when a new frame is available.
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged implementation.
 

Static Protected Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Defines editor information for Kanzi Studio.
 

Detailed Description

App View 3D. Starts and renders a 3rd party application.

Member Typedef Documentation

◆ ConceptClass

Constructor & Destructor Documentation

◆ AppView3D()

AppView3D ( Domain * domain,
string_view name )
explicitprotected

Member Function Documentation

◆ calculateHitUV()

bool calculateHitUV ( const TouchPoint & touchPoint,
Vector2 & outHitUV )
overrideprotectedvirtual

◆ create()

static AppView3DSharedPtr create ( Domain * domain,
string_view name )
static

◆ getOverrideMesh()

MeshSharedPtr getOverrideMesh ( ) const

Gets the value of OverrideMeshProperty.

See also
setMesh()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ( )
staticprotected

Defines editor information for Kanzi Studio.

◆ onAppViewTextureChanged()

void onAppViewTextureChanged ( )
overrideprotectedvirtual

AppView::onAppViewTextureChanged() implementation.

Implements AppViewConceptImpl< Model3D, AppView3D >.

◆ onFinishApp()

void onFinishApp ( FinishAppMessageArguments & messageArguments)

◆ onNavigateBack()

void onNavigateBack ( const NavigateBackMessageArguments & messageArguments)

◆ onNodePropertyChanged()

void onNodePropertyChanged ( AbstractPropertyType propertyType,
PropertyNotificationReason reason )
overrideprotected

Node::onNodePropertyChanged() implementation.

◆ onStartApp()

void onStartApp ( const StartAppMessageArguments & messageArguments)

◆ onUpdateVirtualDisplay()

void onUpdateVirtualDisplay ( const UpdateVirtualDisplayMessageArguments & messageArguments)

◆ setOverrideMesh()

void setOverrideMesh ( ResourceSharedPtr value)

Sets the value of OverrideMeshProperty.

See also
getMesh()

◆ setupMaterialOverride()

void setupMaterialOverride ( )
overrideprotectedvirtual

◆ updateMaterial()

void updateMaterial ( )
protected

◆ updateMesh()

void updateMesh ( )
protected

Member Data Documentation

◆ OverrideMeshProperty

PropertyType<ResourceSharedPtr> OverrideMeshProperty
static

Overrides the default mesh resource.

To disable the override, remove this property.

See also
setMesh(), getMesh()