ImFusion C++ SDK 4.4.0
ImFusion::CT::ConeBeamDisplayOptions Class Referencefinal

#include <ImFusion/CT/GUI/ConeBeamDisplayOptions.h>

Data component for cone-beam display configuration. More...

Inheritance diagram for ImFusion::CT::ConeBeamDisplayOptions:

Detailed Description

Data component for cone-beam display configuration.

Stores rendering options and visualization parameters for cone-beam data in 3D views.

Public Types

enum class  RenderMode3d {
  Off = 0 , Outline , Trajectory , Image ,
  Selection , Everything , Images
}
 Available options for how the cone-beam data should be rendered in an ImageView3D. More...

Public Member Functions

 ConeBeamDisplayOptions (const SharedImageSet &cb)
 ConeBeamDisplayOptions (const ConeBeamDisplayOptions &rhs)
ConeBeamDisplayOptions & operator= (const ConeBeamDisplayOptions &rhs)
bool operator== (const ConeBeamDisplayOptions &rhs) const
std::string id () const override
 Returns a unique string identifier for this type of data component.
Public Member Functions inherited from ImFusion::DataComponent< ConeBeamDisplayOptions >
std::unique_ptr< DataComponentBase > clone () const override
 Creates a clone of this data component.
std::unique_ptr< Subclass > cloneDerived () const
bool assign (const DataComponentBase &other) override
 Assigns the content of other to this data component.
bool equals (const DataComponentBase &other) const override
 Compares this data component to other for equality.
Public Member Functions inherited from ImFusion::Configurable
virtual void configure (const Properties *p)
 Configure this object instance by de-serializing the given Properties.
virtual void configuration (Properties *p) const
 Serialize the current object configuration into the given Properties object.
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 Configurable (const Configurable &rhs)
 Configurable (Configurable &&rhs) noexcept
Configurable & operator= (const Configurable &)
Configurable & operator= (Configurable &&) noexcept

Public Attributes

Parameter< RenderMode3dp_renderMode3d = {"renderMode3d", RenderMode3d::Image, this}
 Render mode to be used in 3D views.
Parameter< bool > p_renderSource = {"renderSource", true, this}
 Additionally render source points for all projections.
Parameter< double > p_sliceOpacity = {"sliceOpacity", 1.0, this}
 Opacity of the rendered slice.
Public Attributes inherited from ImFusion::Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members

Protected Member Functions inherited from ImFusion::DataComponentBase
 DataComponentBase (const DataComponentBase &)=default
DataComponentBase & operator= (const DataComponentBase &other)=default
Protected Attributes inherited from ImFusion::Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

◆ RenderMode3d

Available options for how the cone-beam data should be rendered in an ImageView3D.

Enumerator
Off 

Don't render anything in 3D.

Outline 

Render only an outline of projection annotation for selected image.

Trajectory 

Render projection annotation (outline) for all images.

Image 

Show current image in projection annotation.

Selection 

Show selected images in the view.

Everything 

Show all images and annotations.

Images 

Show all images (as Everything but without annotations).

Member Function Documentation

◆ id()

std::string ImFusion::CT::ConeBeamDisplayOptions::id ( ) const
overridevirtual

Returns a unique string identifier for this type of data component.

Note
To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements ImFusion::DataComponentBase.


The documentation for this class was generated from the following file:
  • ImFusion/CT/GUI/ConeBeamDisplayOptions.h
Search Tab / S to search, Esc to close