CamiTK Python API Overview

Welcome to the CamiTK Python API documentation. Below is a list of all classes available in the camitk module. Click on a class name to see its detailed documentation and available functions.

> Tip: Use the sidebar on the left to navigate between classes easily. API Reference =============

camitk.Action

Action class is an abstract class that enables you to build a action (generally an algorithm that works on specific data, i.e. a specific component).

camitk.Application

The generic/default application.

camitk.Component

A Component represents something that could be included in the explorer view, the interactive 3D viewer, and that could have or not a contextual popup menu (open by a right click in the explorer), a property dialog (to change some properties) Thus, a Component inherits from many abstract classes.

camitk.ComponentExtension

This class describes what is a generic Component extension.

camitk.Core

camitk.ExtensionManager

This class is used to manage all plugins loaded by the application.

camitk.FrameOfReference

FrameOfReference is only a label for an abstract coordinate system.

camitk.HotPlugAction

An Action that can be created on the fly

camitk.ImageComponent

The manager of the Image Volume data.

camitk.InterfaceBitMap

This class describes what are the methods to implement for a BitMap.

camitk.InterfaceFrame

This class describes the methods to implement in order to manage a Component position in space.

camitk.InterfaceGeometry

This class describes what are the methods to implement for a Geometry (rendering parameters, input/output, filters, picking parameters...)

camitk.InterfaceNode

This class describe what are the methods to implement for a hierarchical tree node.

camitk.InterfacePersistence

Interface for all objects that should be serialized by the PersistenceManager

camitk.InterfaceProperty

This class describes what are the methods to implement in order to manage dynamic properties.

camitk.Log

camitk.MeshComponent

Basic component to manage any kind of mesh.

camitk.Property

This class describes a property that can be used in components and actions or any class that needs to be passed to ObjectController.

camitk.PythonHotPlugAction

An Action that is implemented using a Python CamiTK script.

camitk.Transformation

Transformation represents a geometrical transformation between two FrameOfReferences

camitk.TransformationManager

TransformationManager manages frames of reference and transformations for a CamiTK Application

camitk.pythonConsoleRedirect