Kanzi Connect  1.1.10
Kanzi Connect C++ API
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
kanzi::connect::ConsumerViewport2D Class Reference

Consumer viewport 2D. Draws remote content to two dimensional target. More...

#include <consumerviewport2d.hpp>

Inheritance diagram for kanzi::connect::ConsumerViewport2D:

Public Member Functions

 KZ_METACLASS_END ()
 

Static Public Member Functions

static NodeSharedPtr create (Domain *domain, string_view name)
 Creates a video view node. More...
 

Static Public Attributes

static PropertyType< int > MaxFrameQueueSizeProperty
 
static PropertyType< string > StreamIdentifierProperty
 Property type for uri of stream to render. More...
 
static PropertyType< bool > ViewportEnabledProperty
 
static PropertyType< bool > ViewportFlipProperty
 

Protected Member Functions

 ConsumerViewport2D (Domain *domain, string_view name)
 Constructor. More...
 
virtual StreamPlaybackUtilSharedPtr createStreamUtil (Domain &domain, const string &streamId, function< void()> onProcessSampleTask, FrameBufferFactorySharedPtr bufferFactory, const int maxQueueSize)
 
void initialize ()
 initializes Video view. More...
 
virtual Vector2 measureOverride (Vector2) KZ_OVERRIDE
 Node2D::measureOverride() implementation. More...
 
virtual void onAttached () KZ_OVERRIDE
 Node::onAttached() implementation. More...
 
virtual void onDetached () KZ_OVERRIDE
 Node::onDetached() implementation. More...
 
virtual void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
 
virtual void renderForegroundOverride (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &baseTransform) KZ_OVERRIDE
 Node2D::renderForegroundOverride() implementation. More...
 
virtual void updateRenderOverride () KZ_OVERRIDE
 Node2D::updateRenderOverride() implementation. More...
 

Detailed Description

Consumer viewport 2D. Draws remote content to two dimensional target.

Constructor & Destructor Documentation

◆ ConsumerViewport2D()

kanzi::connect::ConsumerViewport2D::ConsumerViewport2D ( Domain *  domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe UI domain the new node belongs to.
nameThe name of the node.

Member Function Documentation

◆ create()

static NodeSharedPtr kanzi::connect::ConsumerViewport2D::create ( Domain *  domain,
string_view  name 
)
static

Creates a video view node.

Parameters
domainThe UI domain the new node belongs to.
nameName of the trajectory layout.
Returns
The created node.

◆ createStreamUtil()

virtual StreamPlaybackUtilSharedPtr kanzi::connect::ConsumerViewport2D::createStreamUtil ( Domain &  domain,
const string &  streamId,
function< void()>  onProcessSampleTask,
FrameBufferFactorySharedPtr  bufferFactory,
const int  maxQueueSize 
)
protectedvirtual

◆ initialize()

void kanzi::connect::ConsumerViewport2D::initialize ( )
protected

initializes Video view.

◆ KZ_METACLASS_END()

kanzi::connect::ConsumerViewport2D::KZ_METACLASS_END ( )

◆ measureOverride()

virtual Vector2 kanzi::connect::ConsumerViewport2D::measureOverride ( Vector2  )
protectedvirtual

Node2D::measureOverride() implementation.

◆ onAttached()

virtual void kanzi::connect::ConsumerViewport2D::onAttached ( )
protectedvirtual

Node::onAttached() implementation.

◆ onDetached()

virtual void kanzi::connect::ConsumerViewport2D::onDetached ( )
protectedvirtual

Node::onDetached() implementation.

◆ onNodePropertyChanged()

virtual void kanzi::connect::ConsumerViewport2D::onNodePropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
protectedvirtual

◆ renderForegroundOverride()

virtual void kanzi::connect::ConsumerViewport2D::renderForegroundOverride ( Renderer3D &  renderer,
CompositionStack &  compositionStack,
const Matrix3x3 &  baseTransform 
)
protectedvirtual

Node2D::renderForegroundOverride() implementation.

◆ updateRenderOverride()

virtual void kanzi::connect::ConsumerViewport2D::updateRenderOverride ( )
protectedvirtual

Node2D::updateRenderOverride() implementation.

Member Data Documentation

◆ MaxFrameQueueSizeProperty

PropertyType<int> kanzi::connect::ConsumerViewport2D::MaxFrameQueueSizeProperty
static

◆ StreamIdentifierProperty

PropertyType<string> kanzi::connect::ConsumerViewport2D::StreamIdentifierProperty
static

Property type for uri of stream to render.

◆ ViewportEnabledProperty

PropertyType<bool> kanzi::connect::ConsumerViewport2D::ViewportEnabledProperty
static

◆ ViewportFlipProperty

PropertyType<bool> kanzi::connect::ConsumerViewport2D::ViewportFlipProperty
static
The documentation for this class was generated from the following file: