inviwopy

Core API

All the bindings for the Inviwo core classes, Processor, Property, Port etc.

Modules

data

Inviwo Data Structures

data.formats

Inviwo Data Formats

glm

GML vec and mat types

properties

Inviwo Properties

camerautil

Camera utilities

doc

Inviwo document classes

Functions

debugBreak()

getApp()

handlePythonOutput(arg0, arg1)

log(source, level, audience, file, function, ...)

logError(arg0)

logInfo(arg0)

logWarn(arg0)

md2doc(arg0)

unindentMd2doc(arg0)

Classes

CanvasProcessor

CodeState

Members:

ConsoleLogger

DataReader

DataReaderFactory

DataWriter

DataWriterFactory

Event

FileLogger

ImageDataReader

ImageDataWriter

Inport

InportVectorWrapper

InteractionEvent

InviwoApplication

InviwoModule

InviwoModuleFactoryObject

IsoValueCollectionDataReader

IsoValueCollectionDataWriter

IvwKey

Members:

KeyModifier

Members:

KeyModifiers

KeyModifiersIterator

KeyState

Members:

KeyStates

KeyStatesIterator

KeyboardEvent

LicenseInfo

LogAudience

Members:

LogCentral

LogLevel

Members:

LogVerbosity

Members:

Logger

MeshDataReader

MeshDataWriter

MessageBreakLevel

Members:

ModuleIdentifierWrapper

ModulePath

Members:

MouseButton

Members:

MouseButtons

MouseButtonsIterator

MouseEvent

MouseInteractionEvent

MouseState

Members:

MouseStates

MouseStatesIterator

Outport

OutportVectorWrapper

PathType

Members:

PickingEvent

PickingHoverState

Members:

PickingHoverStates

PickingHoverStatesIterator

PickingMapper

PickingPressItem

Members:

PickingPressItems

PickingPressItemsIterator

PickingPressState

Members:

PickingPressStates

PickingPressStatesIterator

PickingState

Members:

PickingStates

PickingStatesIterator

Port

PortConnection

Processor

ProcessorFactory

ProcessorFactoryObject

ProcessorInfo

ProcessorMetaData

ProcessorNetwork

ProcessorVecWrapper

ProcessorWidget

ProcessorWidgetFactory

ProcessorWidgetFactoryObject

PropertyLink

ProtectedModule

Members:

PythonInport

PythonOutport

ResizeEvent

Settings

Tag

Tags

TouchDevice

TouchDeviceType

Members:

TouchEvent

TouchPoint

TouchState

Members:

TouchStates

TouchStatesIterator

TransferFunctionDataReader

TransferFunctionDataWriter

Version

ViewEvent

ViewEventFitData

ViewEventFlipUp

VolumeDataReader

VolumeDataWriter

WheelEvent

dmat2VectorFlatMultiInport

dmat2VectorInport

dmat2VectorMultiInport

dmat2VectorOutport

dmat3VectorFlatMultiInport

dmat3VectorInport

dmat3VectorMultiInport

dmat3VectorOutport

dmat4VectorFlatMultiInport

dmat4VectorInport

dmat4VectorMultiInport

dmat4VectorOutport

doubleVector

doubleVectorFlatMultiInport

doubleVectorInport

doubleVectorMultiInport

doubleVectorOutport

dvec2Vector

dvec2VectorFlatMultiInport

dvec2VectorInport

dvec2VectorMultiInport

dvec2VectorOutport

dvec3Vector

dvec3VectorFlatMultiInport

dvec3VectorInport

dvec3VectorMultiInport

dvec3VectorOutport

dvec4Vector

dvec4VectorFlatMultiInport

dvec4VectorInport

dvec4VectorMultiInport

dvec4VectorOutport

floatVector

floatVectorFlatMultiInport

floatVectorInport

floatVectorMultiInport

floatVectorOutport

intVector

intVectorFlatMultiInport

intVectorInport

intVectorMultiInport

intVectorOutport

ivec2Vector

ivec2VectorFlatMultiInport

ivec2VectorInport

ivec2VectorMultiInport

ivec2VectorOutport

ivec3Vector

ivec3VectorFlatMultiInport

ivec3VectorInport

ivec3VectorMultiInport

ivec3VectorOutport

ivec4Vector

ivec4VectorFlatMultiInport

ivec4VectorInport

ivec4VectorMultiInport

ivec4VectorOutport

mat2VectorFlatMultiInport

mat2VectorInport

mat2VectorMultiInport

mat2VectorOutport

mat3VectorFlatMultiInport

mat3VectorInport

mat3VectorMultiInport

mat3VectorOutport

mat4VectorFlatMultiInport

mat4VectorInport

mat4VectorMultiInport

mat4VectorOutport

uintVector

uintVectorFlatMultiInport

uintVectorInport

uintVectorMultiInport

uintVectorOutport

uvec2Vector

uvec2VectorFlatMultiInport

uvec2VectorInport

uvec2VectorMultiInport

uvec2VectorOutport

uvec3Vector

uvec3VectorFlatMultiInport

uvec3VectorInport

uvec3VectorMultiInport

uvec3VectorOutport

uvec4Vector

uvec4VectorFlatMultiInport

uvec4VectorInport

uvec4VectorMultiInport

uvec4VectorOutport

vec2Vector

vec2VectorFlatMultiInport

vec2VectorInport

vec2VectorMultiInport

vec2VectorOutport

vec3Vector

vec3VectorFlatMultiInport

vec3VectorInport

vec3VectorMultiInport

vec3VectorOutport

vec4Vector

vec4VectorFlatMultiInport

vec4VectorInport

vec4VectorMultiInport

vec4VectorOutport

class inviwopy.CanvasProcessor

Bases: Processor

__init__(*args, **kwargs)
getUseCustomDimensions(self: inviwopy.CanvasProcessor) bool
snapshot(self: inviwopy.CanvasProcessor, arg0: os.PathLike) None
snapshotAsync(self: inviwopy.CanvasProcessor, arg0: os.PathLike) None
property customDimensions
property image
property ready
property size
class inviwopy.CodeState

Bases: pybind11_object

Members:

Broken

Experimental

Stable

__eq__(self: object, other: object) bool
__hash__(self: object) int
__index__(self: inviwopy.CodeState) int
__init__(self: inviwopy.CodeState, value: int) None
__int__(self: inviwopy.CodeState) int
__ne__(self: object, other: object) bool
__repr__(self: object) str
__str__(self: object) str
Broken = <CodeState.Broken: 0>
Experimental = <CodeState.Experimental: 1>
Stable = <CodeState.Stable: 2>
property name
property value
class inviwopy.ConsoleLogger

Bases: Logger

__init__(self: inviwopy.ConsoleLogger) None
log(self: inviwopy.ConsoleLogger, arg0: str, arg1: inviwopy.LogLevel, arg2: inviwopy.LogAudience, arg3: str, arg4: str, arg5: int, arg6: str) None
class inviwopy.DataReader

Bases: pybind11_object

__init__(*args, **kwargs)
addExtension(self: inviwopy.DataReader, arg0: inviwopy.properties.FileExtension) None
clone(self: inviwopy.DataReader) inviwopy.DataReader
getOption(self: inviwopy.DataReader, arg0: str) std::any
setOption(self: inviwopy.DataReader, arg0: str, arg1: std::any) bool
property extensions
class inviwopy.DataReaderFactory

Bases: pybind11_object

__init__(*args, **kwargs)
create(*args, **kwargs)

Overloaded function.

  1. create(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.DataReader

  2. create(self: inviwopy.DataReaderFactory, arg0: str) -> inviwopy.DataReader

getExtensionsForImage(self: inviwopy.DataReaderFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getExtensionsForIsoValueCollection(self: inviwopy.DataReaderFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getExtensionsForMesh(self: inviwopy.DataReaderFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getExtensionsForTransferFunction(self: inviwopy.DataReaderFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getExtensionsForVolume(self: inviwopy.DataReaderFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getImageReader(*args, **kwargs)

Overloaded function.

  1. getImageReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> inviwopy.ImageDataReader

  2. getImageReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.ImageDataReader

  3. getImageReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.ImageDataReader

getIsoValueCollectionReader(*args, **kwargs)

Overloaded function.

  1. getIsoValueCollectionReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> inviwopy.IsoValueCollectionDataReader

  2. getIsoValueCollectionReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.IsoValueCollectionDataReader

  3. getIsoValueCollectionReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.IsoValueCollectionDataReader

getMeshReader(*args, **kwargs)

Overloaded function.

  1. getMeshReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> inviwopy.MeshDataReader

  2. getMeshReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.MeshDataReader

  3. getMeshReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.MeshDataReader

getTransferFunctionReader(*args, **kwargs)

Overloaded function.

  1. getTransferFunctionReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> inviwopy.TransferFunctionDataReader

  2. getTransferFunctionReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.TransferFunctionDataReader

  3. getTransferFunctionReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.TransferFunctionDataReader

getVolumeReader(*args, **kwargs)

Overloaded function.

  1. getVolumeReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> inviwopy.VolumeDataReader

  2. getVolumeReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.VolumeDataReader

  3. getVolumeReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.VolumeDataReader

hasImageReader(*args, **kwargs)

Overloaded function.

  1. hasImageReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> bool

  2. hasImageReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasIsoValueCollectionReader(*args, **kwargs)

Overloaded function.

  1. hasIsoValueCollectionReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> bool

  2. hasIsoValueCollectionReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasKey(*args, **kwargs)

Overloaded function.

  1. hasKey(self: inviwopy.DataReaderFactory, arg0: str) -> bool

  2. hasKey(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasMeshReader(*args, **kwargs)

Overloaded function.

  1. hasMeshReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> bool

  2. hasMeshReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasTransferFunctionReader(*args, **kwargs)

Overloaded function.

  1. hasTransferFunctionReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> bool

  2. hasTransferFunctionReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasVolumeReader(*args, **kwargs)

Overloaded function.

  1. hasVolumeReader(self: inviwopy.DataReaderFactory, arg0: os.PathLike) -> bool

  2. hasVolumeReader(self: inviwopy.DataReaderFactory, arg0: inviwopy.properties.FileExtension) -> bool

readImage(self: inviwopy.DataReaderFactory, arg0: os.PathLike, arg1: std::optional<inviwo::FileExtension>) inviwopy.data.Image
readIsoValueCollection(self: inviwopy.DataReaderFactory, arg0: os.PathLike, arg1: std::optional<inviwo::FileExtension>) inviwopy.data.IsoValueCollection
readMesh(self: inviwopy.DataReaderFactory, arg0: os.PathLike, arg1: std::optional<inviwo::FileExtension>) inviwopy.data.Mesh
readTransferFunction(self: inviwopy.DataReaderFactory, arg0: os.PathLike, arg1: std::optional<inviwo::FileExtension>) inviwopy.data.TransferFunction
readVolume(self: inviwopy.DataReaderFactory, arg0: os.PathLike, arg1: std::optional<inviwo::FileExtension>) inviwopy.data.Volume
class inviwopy.DataWriter

Bases: pybind11_object

__init__(*args, **kwargs)
addExtension(self: inviwopy.DataWriter, arg0: inviwopy.properties.FileExtension) None
clone(self: inviwopy.DataWriter) inviwopy.DataWriter
getOption(self: inviwopy.DataWriter, arg0: str) std::any
getOverwrite(self: inviwopy.DataWriter) inviwo::Overwrite
setOption(self: inviwopy.DataWriter, arg0: str, arg1: std::any) bool
setOverwrite(self: inviwopy.DataWriter, arg0: inviwo::Overwrite) None
property extensions
class inviwopy.DataWriterFactory

Bases: pybind11_object

__init__(*args, **kwargs)
create(*args, **kwargs)

Overloaded function.

  1. create(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.DataWriter

  2. create(self: inviwopy.DataWriterFactory, arg0: str) -> inviwopy.DataWriter

getExtensionsForImage(self: inviwopy.DataWriterFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getExtensionsForIsoValueCollection(self: inviwopy.DataWriterFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getExtensionsForMesh(self: inviwopy.DataWriterFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getExtensionsForTransferFunction(self: inviwopy.DataWriterFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getExtensionsForVolume(self: inviwopy.DataWriterFactory) std::vector<inviwo::FileExtension,std::allocator<inviwo::FileExtension> >
getImageWriter(*args, **kwargs)

Overloaded function.

  1. getImageWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> inviwopy.ImageDataWriter

  2. getImageWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.ImageDataWriter

  3. getImageWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.ImageDataWriter

getIsoValueCollectionWriter(*args, **kwargs)

Overloaded function.

  1. getIsoValueCollectionWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> inviwopy.IsoValueCollectionDataWriter

  2. getIsoValueCollectionWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.IsoValueCollectionDataWriter

  3. getIsoValueCollectionWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.IsoValueCollectionDataWriter

getMeshWriter(*args, **kwargs)

Overloaded function.

  1. getMeshWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> inviwopy.MeshDataWriter

  2. getMeshWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.MeshDataWriter

  3. getMeshWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.MeshDataWriter

getTransferFunctionWriter(*args, **kwargs)

Overloaded function.

  1. getTransferFunctionWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> inviwopy.TransferFunctionDataWriter

  2. getTransferFunctionWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.TransferFunctionDataWriter

  3. getTransferFunctionWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.TransferFunctionDataWriter

getVolumeWriter(*args, **kwargs)

Overloaded function.

  1. getVolumeWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> inviwopy.VolumeDataWriter

  2. getVolumeWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> inviwopy.VolumeDataWriter

  3. getVolumeWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension, arg1: os.PathLike) -> inviwopy.VolumeDataWriter

hasImageWriter(*args, **kwargs)

Overloaded function.

  1. hasImageWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> bool

  2. hasImageWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasIsoValueCollectionWriter(*args, **kwargs)

Overloaded function.

  1. hasIsoValueCollectionWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> bool

  2. hasIsoValueCollectionWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasKey(*args, **kwargs)

Overloaded function.

  1. hasKey(self: inviwopy.DataWriterFactory, arg0: str) -> bool

  2. hasKey(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasMeshWriter(*args, **kwargs)

Overloaded function.

  1. hasMeshWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> bool

  2. hasMeshWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasTransferFunctionWriter(*args, **kwargs)

Overloaded function.

  1. hasTransferFunctionWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> bool

  2. hasTransferFunctionWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> bool

hasVolumeWriter(*args, **kwargs)

Overloaded function.

  1. hasVolumeWriter(self: inviwopy.DataWriterFactory, arg0: os.PathLike) -> bool

  2. hasVolumeWriter(self: inviwopy.DataWriterFactory, arg0: inviwopy.properties.FileExtension) -> bool

writeImage(self: inviwopy.DataWriterFactory, arg0: inviwopy.data.Image, arg1: os.PathLike, arg2: std::optional<inviwo::FileExtension>) bool
writeIsoValueCollection(self: inviwopy.DataWriterFactory, arg0: inviwopy.data.IsoValueCollection, arg1: os.PathLike, arg2: std::optional<inviwo::FileExtension>) bool
writeMesh(self: inviwopy.DataWriterFactory, arg0: inviwopy.data.Mesh, arg1: os.PathLike, arg2: std::optional<inviwo::FileExtension>) bool
writeTransferFunction(self: inviwopy.DataWriterFactory, arg0: inviwopy.data.TransferFunction, arg1: os.PathLike, arg2: std::optional<inviwo::FileExtension>) bool
writeVolume(self: inviwopy.DataWriterFactory, arg0: inviwopy.data.Volume, arg1: os.PathLike, arg2: std::optional<inviwo::FileExtension>) bool
class inviwopy.Event

Bases: pybind11_object

__init__(*args, **kwargs)
__repr__(self: inviwopy.Event) str
clone(self: inviwopy.Event) inviwopy.Event
getVisitedProcessors(self: inviwopy.Event) list[inviwopy.Processor]
hasBeenUsed(self: inviwopy.Event) bool
hasVisitedProcessor(self: inviwopy.Event, arg0: inviwopy.Processor) bool
hash(self: inviwopy.Event) int
markAsUnused(self: inviwopy.Event) bool
markAsUsed(self: inviwopy.Event) bool
markAsVisited(*args, **kwargs)

Overloaded function.

  1. markAsVisited(self: inviwopy.Event, arg0: inviwopy.Processor) -> bool

  2. markAsVisited(self: inviwopy.Event, arg0: inviwopy.Event) -> None

setUsed(self: inviwopy.Event, arg0: bool) bool
shouldPropagateTo(self: inviwopy.Event, arg0: inviwopy.Inport, arg1: inviwopy.Processor, arg2: inviwopy.Outport) bool
property used
class inviwopy.FileLogger

Bases: Logger

__init__(self: inviwopy.FileLogger, arg0: str) None
log(self: inviwopy.FileLogger, arg0: str, arg1: inviwopy.LogLevel, arg2: inviwopy.LogAudience, arg3: str, arg4: str, arg5: int, arg6: str) None
class inviwopy.ImageDataReader

Bases: DataReader

__init__(*args, **kwargs)
readData(*args, **kwargs)

Overloaded function.

  1. readData(self: inviwopy.ImageDataReader, arg0: os.PathLike) -> inviwopy.data.Image

  2. readData(self: inviwopy.ImageDataReader, arg0: os.PathLike, arg1: inviwo::MetaDataOwner) -> inviwopy.data.Image

class inviwopy.ImageDataWriter

Bases: DataWriter

__init__(*args, **kwargs)
writeData(self: inviwopy.ImageDataWriter, arg0: inviwopy.data.Image, arg1: os.PathLike) None
class inviwopy.Inport

Bases: Port

__init__(*args, **kwargs)
canConnectTo(self: inviwopy.Inport, arg0: inviwopy.Port) bool
connectTo(self: inviwopy.Inport, arg0: inviwo::Outport) None
disconnectFrom(self: inviwopy.Inport, arg0: inviwo::Outport) None
getChangedOutports(self: inviwopy.Inport) list[inviwo::Outport]
getConnectedOutport(self: inviwopy.Inport) inviwo::Outport
getConnectedOutports(self: inviwopy.Inport) list[inviwo::Outport]
getMaxNumberOfConnections(self: inviwopy.Inport) int
getNumberOfConnections(self: inviwopy.Inport) int
isChanged(self: inviwopy.Inport) bool
isConnectedTo(self: inviwopy.Inport, arg0: inviwo::Outport) bool
onChangeScoped(self: inviwopy.Inport, arg0: std::function<void __cdecl(void)>) std::function<void __cdecl(void)>
onConnectScoped(self: inviwopy.Inport, arg0: std::function<void __cdecl(inviwo::Outport * __ptr64)>) std::function<void __cdecl(inviwo::Outport * __ptr64)>
onDisconnectScoped(self: inviwopy.Inport, arg0: std::function<void __cdecl(inviwo::Outport * __ptr64)>) std::function<void __cdecl(inviwo::Outport * __ptr64)>
onInvalidScoped(self: inviwopy.Inport, arg0: std::function<void __cdecl(void)>) std::function<void __cdecl(void)>
property optional
class inviwopy.InportVectorWrapper

Bases: pybind11_object

__contains__(self: inviwopy.InportVectorWrapper, arg0: str) bool
__dir__(self: inviwopy.InportVectorWrapper) list[str]
__getattr__(self: inviwopy.InportVectorWrapper, arg0: str) inviwopy.Inport
__getitem__(*args, **kwargs)

Overloaded function.

  1. __getitem__(self: inviwopy.InportVectorWrapper, arg0: str) -> inviwopy.Inport

  2. __getitem__(self: inviwopy.InportVectorWrapper, arg0: int) -> inviwopy.Inport

__init__(*args, **kwargs)
__len__(self: inviwopy.InportVectorWrapper) int
__repr__(self: inviwopy.InportVectorWrapper) str
class inviwopy.InteractionEvent

Bases: Event

__init__(*args, **kwargs)
modifierNames(self: inviwopy.InteractionEvent) str
modifiers(self: inviwopy.InteractionEvent) inviwopy.KeyModifiers
setModifiers(self: inviwopy.InteractionEvent, arg0: inviwopy.KeyModifiers) None
setToolTip(self: inviwopy.InteractionEvent, arg0: str) None
class inviwopy.InviwoApplication

Bases: pybind11_object

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: inviwopy.InviwoApplication) -> None

  2. __init__(self: inviwopy.InviwoApplication, arg0: str) -> None

getBasePath(self: inviwopy.InviwoApplication) os.PathLike
getModuleByIdentifier(self: inviwopy.InviwoApplication, arg0: str) inviwo::InviwoModule
getModuleSettings(self: inviwopy.InviwoApplication) list[inviwo::Settings]
getOutputPath(self: inviwopy.InviwoApplication) os.PathLike
getPath(self: inviwopy.InviwoApplication, pathType: inviwopy.PathType, suffix: str = '', createFolder: bool = False) os.PathLike
getPoolSize(self: inviwopy.InviwoApplication) int
registerModules(self: inviwopy.InviwoApplication, arg0: list[inviwo::InviwoModuleFactoryObject]) None
registerRuntimeModules(*args, **kwargs)

Overloaded function.

  1. registerRuntimeModules(self: inviwopy.InviwoApplication) -> None

  2. registerRuntimeModules(self: inviwopy.InviwoApplication, arg0: Callable[[str], bool]) -> None

resizePool(self: inviwopy.InviwoApplication, arg0: int) None
runningBackgroundJobs(self: inviwopy.InviwoApplication) int
setProgressCallback(self: inviwopy.InviwoApplication, arg0: Callable[[str], None]) None
waitForPool(self: inviwopy.InviwoApplication) None
property basePath
property dataReaderFactory
property dataWriterFactory
property displayName
property modules
property network

Get the processor network

property processorFactory
property propertyFactory
class inviwopy.InviwoModule

Bases: pybind11_object

__init__(self: inviwopy.InviwoModule, arg0: inviwopy.InviwoApplication, arg1: str) None
__repr__(self: inviwopy.InviwoModule) str
getPath(self: inviwopy.InviwoModule, arg0: inviwopy.ModulePath) os.PathLike
registerProcessor(self: inviwopy.InviwoModule, arg0: object) None
property description
property identifier
property path
property version
class inviwopy.InviwoModuleFactoryObject

Bases: pybind11_object

__init__(self: inviwopy.InviwoModuleFactoryObject, name: str, version: inviwopy.Version, description: str = '', srcPath: os.PathLike = WindowsPath('.'), inviwoCoreVersion: inviwopy.Version, dependencies: list[str] = [], dependenciesVersion: list[inviwopy.Version] = [], aliases: list[str] = [], licenses: list[inviwopy.LicenseInfo] = [], protectedModule: inviwopy.ProtectedModule = <ProtectedModule.off: 1>) None
__repr__(self: inviwopy.InviwoModuleFactoryObject) str
create(self: inviwopy.InviwoModuleFactoryObject, arg0: inviwopy.InviwoApplication) inviwopy.InviwoModule
property aliases
property dependencies
property description
property inviwoCoreVersion
property licenses
property name
property protectedModule
property version
class inviwopy.IsoValueCollectionDataReader

Bases: DataReader

__init__(*args, **kwargs)
readData(*args, **kwargs)

Overloaded function.

  1. readData(self: inviwopy.IsoValueCollectionDataReader, arg0: os.PathLike) -> inviwopy.data.IsoValueCollection

  2. readData(self: inviwopy.IsoValueCollectionDataReader, arg0: os.PathLike, arg1: inviwo::MetaDataOwner) -> inviwopy.data.IsoValueCollection

class inviwopy.IsoValueCollectionDataWriter

Bases: DataWriter

__init__(*args, **kwargs)
writeData(self: inviwopy.IsoValueCollectionDataWriter, arg0: inviwopy.data.IsoValueCollection, arg1: os.PathLike) None
class inviwopy.IvwKey

Bases: pybind11_object

Members:

Undefined

Unknown

Space

Exclam

QuoteDbl

NumberSign

Dollar

Percent

Ampersand

Apostrophe

ParenLeft

ParenRight

Asterisk

Plus

Comma

Minus

Period

Slash

Num0

Num1

Num2

Num3

Num4

Num5

Num6

Num7

Num8

Num9

Colon

Semicolon

Less

Equal

Greater

Question

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

BracketLeft

Backslash

BracketRight

GraveAccent

AsciiCircum

Underscore

BraceLeft

Bar

BraceRight

AsciiTilde

World1

World2

Escape

Enter

Tab

Backspace

Insert

Delete

Right

Left

Down

Up

PageUp

PageDown

Home

End

CapsLock

ScrollLock

NumLock

PrintScreen

Pause

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

F13

F14

F15

F16

F17

F18

F19

F20

F21

F22

F23

F24

F25

KP0

KP1

KP2

KP3

KP4

KP5

KP6

KP7

KP8

KP9

KPDecimal

KPDivide

KPMultiply

KPSubtract

KPAdd

KPEnter

KPEqual

LeftShift

LeftControl

LeftAlt

LeftSuper

RightShift

RightControl

RightAlt

RightSuper

Menu

LeftMeta

RightMeta

__eq__(self: object, other: object) bool
__hash__(self: object) int
__index__(self: inviwopy.IvwKey) int
__init__(self: inviwopy.IvwKey, value: int) None
__int__(self: inviwopy.IvwKey) int
__ne__(self: object, other: object) bool
__repr__(self: object) str
__str__(self: object) str
A = <IvwKey.A: 65>
Ampersand = <IvwKey.Ampersand: 38>
Apostrophe = <IvwKey.Apostrophe: 39>
AsciiCircum = <IvwKey.AsciiCircum: 94>
AsciiTilde = <IvwKey.AsciiTilde: 126>
Asterisk = <IvwKey.Asterisk: 42>
B = <IvwKey.B: 66>
Backslash = <IvwKey.Backslash: 92>
Backspace = <IvwKey.Backspace: 259>
Bar = <IvwKey.Bar: 124>
BraceLeft = <IvwKey.BraceLeft: 123>
BraceRight = <IvwKey.BraceRight: 125>
BracketLeft = <IvwKey.BracketLeft: 91>
BracketRight = <IvwKey.BracketRight: 93>
C = <IvwKey.C: 67>
CapsLock = <IvwKey.CapsLock: 280>
Colon = <IvwKey.Colon: 58>
Comma = <IvwKey.Comma: 44>
D = <IvwKey.D: 68>
Delete = <IvwKey.Delete: 261>
Dollar = <IvwKey.Dollar: 36>
Down = <IvwKey.Down: 264>
E = <IvwKey.E: 69>
End = <IvwKey.End: 269>
Enter = <IvwKey.Enter: 257>
Equal = <IvwKey.Equal: 61>
Escape = <IvwKey.Escape: 256>
Exclam = <IvwKey.Exclam: 33>
F = <IvwKey.F: 70>
F1 = <IvwKey.F1: 290>
F10 = <IvwKey.F10: 299>
F11 = <IvwKey.F11: 300>
F12 = <IvwKey.F12: 301>
F13 = <IvwKey.F13: 302>
F14 = <IvwKey.F14: 303>
F15 = <IvwKey.F15: 304>
F16 = <IvwKey.F16: 305>
F17 = <IvwKey.F17: 306>
F18 = <IvwKey.F18: 307>
F19 = <IvwKey.F19: 308>
F2 = <IvwKey.F2: 291>
F20 = <IvwKey.F20: 309>
F21 = <IvwKey.F21: 310>
F22 = <IvwKey.F22: 311>
F23 = <IvwKey.F23: 312>
F24 = <IvwKey.F24: 313>
F25 = <IvwKey.F25: 314>
F3 = <IvwKey.F3: 292>
F4 = <IvwKey.F4: 293>
F5 = <IvwKey.F5: 294>
F6 = <IvwKey.F6: 295>
F7 = <IvwKey.F7: 296>
F8 = <IvwKey.F8: 297>
F9 = <IvwKey.F9: 298>
G = <IvwKey.G: 71>
GraveAccent = <IvwKey.GraveAccent: 96>
Greater = <IvwKey.Greater: 62>
H = <IvwKey.H: 72>
Home = <IvwKey.Home: 268>
I = <IvwKey.I: 73>
Insert = <IvwKey.Insert: 260>
J = <IvwKey.J: 74>
K = <IvwKey.K: 75>
KP0 = <IvwKey.KP0: 320>
KP1 = <IvwKey.KP1: 321>
KP2 = <IvwKey.KP2: 322>
KP3 = <IvwKey.KP3: 323>
KP4 = <IvwKey.KP4: 324>
KP5 = <IvwKey.KP5: 325>
KP6 = <IvwKey.KP6: 326>
KP7 = <IvwKey.KP7: 327>
KP8 = <IvwKey.KP8: 328>
KP9 = <IvwKey.KP9: 329>
KPAdd = <IvwKey.KPAdd: 334>
KPDecimal = <IvwKey.KPDecimal: 330>
KPDivide = <IvwKey.KPDivide: 331>
KPEnter = <IvwKey.KPEnter: 335>
KPEqual = <IvwKey.KPEqual: 336>
KPMultiply = <IvwKey.KPMultiply: 332>
KPSubtract = <IvwKey.KPSubtract: 333>
L = <IvwKey.L: 76>
Left = <IvwKey.Left: 263>
LeftAlt = <IvwKey.LeftAlt: 342>
LeftControl = <IvwKey.LeftControl: 341>
LeftMeta = <IvwKey.LeftMeta: 349>
LeftShift = <IvwKey.LeftShift: 340>
LeftSuper = <IvwKey.LeftSuper: 343>
Less = <IvwKey.Less: 60>
M = <IvwKey.M: 77>
Menu = <IvwKey.Menu: 348>
Minus = <IvwKey.Minus: 45>
N = <IvwKey.N: 78>
Num0 = <IvwKey.Num0: 48>
Num1 = <IvwKey.Num1: 49>
Num2 = <IvwKey.Num2: 50>
Num3 = <IvwKey.Num3: 51>
Num4 = <IvwKey.Num4: 52>
Num5 = <IvwKey.Num5: 53>
Num6 = <IvwKey.Num6: 54>
Num7 = <IvwKey.Num7: 55>
Num8 = <IvwKey.Num8: 56>
Num9 = <IvwKey.Num9: 57>
NumLock = <IvwKey.NumLock: 282>
NumberSign = <IvwKey.NumberSign: 35>
O = <IvwKey.O: 79>
P = <IvwKey.P: 80>
PageDown = <IvwKey.PageDown: 267>
PageUp = <IvwKey.PageUp: 266>
ParenLeft = <IvwKey.ParenLeft: 40>
ParenRight = <IvwKey.ParenRight: 41>
Pause = <IvwKey.Pause: 284>
Percent = <IvwKey.Percent: 37>
Period = <IvwKey.Period: 46>
Plus = <IvwKey.Plus: 43>
PrintScreen = <IvwKey.PrintScreen: 283>
Q = <IvwKey.Q: 81>
Question = <IvwKey.Question: 63>
QuoteDbl = <IvwKey.QuoteDbl: 34>
R = <IvwKey.R: 82>
Right = <IvwKey.Right: 262>
RightAlt = <IvwKey.RightAlt: 346>
RightControl = <IvwKey.RightControl: 345>
RightMeta = <IvwKey.RightMeta: 350>
RightShift = <IvwKey.RightShift: 344>
RightSuper = <IvwKey.RightSuper: 347>
S = <IvwKey.S: 83>
ScrollLock = <IvwKey.ScrollLock: 281>
Semicolon = <IvwKey.Semicolon: 59>
Slash = <IvwKey.Slash: 47>
Space = <IvwKey.Space: 32>
T = <IvwKey.T: 84>
Tab = <IvwKey.Tab: 258>
U = <IvwKey.U: 85>
Undefined = <IvwKey.Undefined: -2>
Underscore = <IvwKey.Underscore: 95>
Unknown = <IvwKey.Unknown: -1>
Up = <IvwKey.Up: 265>
V = <IvwKey.V: 86>
W = <IvwKey.W: 87>
World1 = <IvwKey.World1: 161>
World2 = <IvwKey.World2: 162>
X = <IvwKey.X: 88>
Y = <IvwKey.Y: 89>
Z = <IvwKey.Z: 90>
property name
property value
class inviwopy.KeyModifier

Bases: pybind11_object

Members:

NoModifier

Control

Shift

Alt

Super

Menu

Meta

__and__(self: inviwopy.KeyModifier, arg0: inviwopy.KeyModifier) inviwopy.KeyModifiers
__eq__(self: object, other: object) bool
__hash__(self: object) int
__index__(self: inviwopy.KeyModifier) int
__init__(self: inviwopy.KeyModifier, value: int) None
__int__(self: inviwopy.KeyModifier) int
__ne__(self: object, other: object) bool
__or__(self: inviwopy.KeyModifier, arg0: inviwopy.KeyModifier) inviwopy.KeyModifiers
__repr__(self: object) str
__str__(self: object) str
__xor__(self: inviwopy.KeyModifier, arg0: inviwopy.KeyModifier) inviwopy.KeyModifiers
Alt = <KeyModifier.Alt: 4>
Control = <KeyModifier.Control: 1>
Menu = <KeyModifier.Menu: 16>
Meta = <KeyModifier.Meta: 32>
NoModifier = <KeyModifier.NoModifier: 0>
Shift = <KeyModifier.Shift: 2>
Super = <KeyModifier.Super: 8>
property name
property value
class inviwopy.KeyModifiers

Bases: pybind11_object

__and__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) inviwopy.KeyModifiers
__eq__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) bool
__iand__(*args, **kwargs)

Overloaded function.

  1. __iand__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) -> inviwopy.KeyModifiers

  2. __iand__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) -> inviwopy.KeyModifiers

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: inviwopy.KeyModifiers) -> None

  2. __init__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) -> None

  3. __init__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) -> None

  4. __init__(self: inviwopy.KeyModifiers, *args) -> None

__invert__(self: inviwopy.KeyModifiers) inviwopy.KeyModifiers
__ior__(*args, **kwargs)

Overloaded function.

  1. __ior__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) -> inviwopy.KeyModifiers

  2. __ior__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) -> inviwopy.KeyModifiers

__iter__(self: inviwopy.KeyModifiers) inviwopy.KeyModifiersIterator
__ixor__(*args, **kwargs)

Overloaded function.

  1. __ixor__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) -> inviwopy.KeyModifiers

  2. __ixor__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) -> inviwopy.KeyModifiers

__ne__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) bool
__or__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) inviwopy.KeyModifiers
__repr__(self: inviwopy.KeyModifiers) str
__str__(self: inviwopy.KeyModifiers) str
__xor__(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifiers) inviwopy.KeyModifiers
clear(self: inviwopy.KeyModifiers) None
contains(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) bool
count(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) int
empty(*args, **kwargs)

Overloaded function.

  1. empty(self: inviwopy.KeyModifiers) -> bool

  2. empty(self: inviwopy.KeyModifiers) -> bool

erase(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) int
find(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) inviwopy.KeyModifiersIterator
insert(self: inviwopy.KeyModifiers, arg0: inviwopy.KeyModifier) tuple[inviwopy.KeyModifiersIterator, bool]
max_size(self: inviwopy.KeyModifiers) int
size(self: inviwopy.KeyModifiers) int
__hash__ = None
class inviwopy.KeyModifiersIterator

Bases: pybind11_object

__init__(self: inviwopy.KeyModifiersIterator, arg0: inviwopy.KeyModifiersIterator) None
__iter__(self: inviwopy.KeyModifiersIterator) inviwopy.KeyModifiersIterator
__next__(self: inviwopy.KeyModifiersIterator) inviwopy.KeyModifier
class inviwopy.KeyState

Bases: pybind11_object

Members:

Press

Release

__and__(self: inviwopy.KeyState, arg0: inviwopy.KeyState) inviwopy.KeyStates
__eq__(self: object, other: object) bool
__hash__(self: object) int
__index__(self: inviwopy.KeyState) int
__init__(self: inviwopy.KeyState, value: int) None
__int__(self: inviwopy.KeyState) int
__ne__(self: object, other: object) bool
__or__(self: inviwopy.KeyState, arg0: inviwopy.KeyState) inviwopy.KeyStates
__repr__(self: object) str
__str__(self: object) str
__xor__(self: inviwopy.KeyState, arg0: inviwopy.KeyState) inviwopy.KeyStates
Press = <KeyState.Press: 1>
Release = <KeyState.Release: 2>
property name
property value
class inviwopy.KeyStates

Bases: pybind11_object

__and__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) inviwopy.KeyStates
__eq__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) bool
__iand__(*args, **kwargs)

Overloaded function.

  1. __iand__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) -> inviwopy.KeyStates

  2. __iand__(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) -> inviwopy.KeyStates

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: inviwopy.KeyStates) -> None

  2. __init__(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) -> None

  3. __init__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) -> None

  4. __init__(self: inviwopy.KeyStates, *args) -> None

__invert__(self: inviwopy.KeyStates) inviwopy.KeyStates
__ior__(*args, **kwargs)

Overloaded function.

  1. __ior__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) -> inviwopy.KeyStates

  2. __ior__(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) -> inviwopy.KeyStates

__iter__(self: inviwopy.KeyStates) inviwopy.KeyStatesIterator
__ixor__(*args, **kwargs)

Overloaded function.

  1. __ixor__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) -> inviwopy.KeyStates

  2. __ixor__(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) -> inviwopy.KeyStates

__ne__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) bool
__or__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) inviwopy.KeyStates
__repr__(self: inviwopy.KeyStates) str
__str__(self: inviwopy.KeyStates) str
__xor__(self: inviwopy.KeyStates, arg0: inviwopy.KeyStates) inviwopy.KeyStates
clear(self: inviwopy.KeyStates) None
contains(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) bool
count(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) int
empty(*args, **kwargs)

Overloaded function.

  1. empty(self: inviwopy.KeyStates) -> bool

  2. empty(self: inviwopy.KeyStates) -> bool

erase(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) int
find(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) inviwopy.KeyStatesIterator
insert(self: inviwopy.KeyStates, arg0: inviwopy.KeyState) tuple[inviwopy.KeyStatesIterator, bool]
max_size(self: inviwopy.KeyStates) int
size(self: inviwopy.KeyStates) int
__hash__ = None
class inviwopy.KeyStatesIterator

Bases: pybind11_object

__init__(self: inviwopy.KeyStatesIterator, arg0: inviwopy.KeyStatesIterator) None
__iter__(self: inviwopy.KeyStatesIterator) inviwopy.KeyStatesIterator
__next__(self: inviwopy.KeyStatesIterator) inviwopy.KeyState
class inviwopy.KeyboardEvent

Bases: InteractionEvent

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: inviwopy.KeyboardEvent, key: inviwopy.IvwKey = <IvwKey.Unknown: -1>, state: inviwopy.KeyState = <KeyState.Press: 1>, modifiers: inviwopy.KeyModifiers = <KeyModifier.NoModifier: 0>, nativeVirtualKey: int = 0, utfText: str = ‘’) -> None

  2. __init__(self: inviwopy.KeyboardEvent, arg0: inviwopy.KeyboardEvent) -> None

property chash
property key
property nativeVirtualKey
property state
property text
class inviwopy.LicenseInfo

Bases: pybind11_object

__init__(self: inviwopy.LicenseInfo, id: str, name: str, version: str, url: str, module: str, type: str, files: list[str]) None
property files
property id
property module
property name
property type
property url
property version
class inviwopy.LogAudience

Bases: pybind11_object

Members:

User

Developer

__eq__(self: object, other: object) bool
__hash__(self: object) int