Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoImageVizEngineOutput< OutputFieldType, OutputType > Class Template Reference

ImageViz Image Processing output class. More...

#include <ImageViz/Engines/SoImageVizEngineOutput.h>

+ Inheritance diagram for SoImageVizEngineOutput< OutputFieldType, OutputType >:

Public Member Functions

 SoImageVizEngineOutput ()
 Constructor.
 
virtual ~SoImageVizEngineOutput ()
 Destructor.
 
OutputType getValue () const
 Return the cached output value.
 
void setValue (OutputType value)
 Set the cached output value.
 
- Public Member Functions inherited from SoEngineOutput
SoType getConnectionType () const
 Returns the type of field this output can connect to.
 
int getForwardConnections (SoFieldList &list) const
 Returns the number of fields this output is writing to, and adds references to those fields to the given list.
 
void enable (SbBool flag)
 Enables or disables all connections from this output.
 
SbBool isEnabled () const
 Returns TRUE if this output is currently enabled.
 
SoEnginegetContainer () const
 Returns containing engine.
 
int getNumConnections () const
 Number of connections this output currently has.
 

Friends

class SoImageVizEngineOutputPrivateAccessor
 

Detailed Description

template<typename OutputFieldType, typename OutputType>
class SoImageVizEngineOutput< OutputFieldType, OutputType >

ImageViz Image Processing output class.

This class is similar to SoEngineOutput except that it keep a reference to output's value even if no one is connected. It allow to share output across multiple connections and provides direct access to the output without any engine connection by using the getValue() method.

SEE ALSO

SoEngineOutput

Definition at line 70 of file SoImageVizEngineOutput.h.

Constructor & Destructor Documentation

◆ SoImageVizEngineOutput()

template<typename OutputFieldType , typename OutputType >
SoImageVizEngineOutput< OutputFieldType, OutputType >::SoImageVizEngineOutput ( )
inline

Constructor.

Definition at line 75 of file SoImageVizEngineOutput.h.

◆ ~SoImageVizEngineOutput()

template<typename OutputFieldType , typename OutputType >
virtual SoImageVizEngineOutput< OutputFieldType, OutputType >::~SoImageVizEngineOutput ( )
inlinevirtual

Destructor.

Definition at line 79 of file SoImageVizEngineOutput.h.

Member Function Documentation

◆ getValue()

template<typename OutputFieldType , typename OutputType >
OutputType SoImageVizEngineOutput< OutputFieldType, OutputType >::getValue ( ) const
inline

Return the cached output value.

Definition at line 83 of file SoImageVizEngineOutput.h.

◆ setValue()

template<typename OutputFieldType , typename OutputType >
void SoImageVizEngineOutput< OutputFieldType, OutputType >::setValue ( OutputType  value)
inline

Set the cached output value.

This method should only be used when implementing a custom engine.

This design is to be evolved in the near future.

Definition at line 95 of file SoImageVizEngineOutput.h.

Friends And Related Symbol Documentation

◆ SoImageVizEngineOutputPrivateAccessor

template<typename OutputFieldType , typename OutputType >
friend class SoImageVizEngineOutputPrivateAccessor
friend

Definition at line 129 of file SoImageVizEngineOutput.h.


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