Module k3d
[hide private]
[frames] | no frames]

Module k3d

Provides access to the K-3D API

Classes [hide private]
  angle_axis
Encodes a change in orientation as a rotation around an arbitrary axis.
  atk
  bezier_triangle_patch
  bicubic_patch
  bilinear_patch
  bitmap
Stores a two-dimensional half-precision floating-point RGBA bitmap image.
  blobby
  bounding_box3
Stores a three-dimensional bounding box.
  color
Stores a color using half-precision floating-point RGB values.
  cone
  const_bitmap
Stores a two-dimensional half-precision floating-point RGBA bitmap image.
  const_mesh
Stores a heterogeneous, immutable collection of geometric mesh primitives.
  const_named_arrays
Stores an immutable (read-only) collection of named arrays (with unrelated lengths).
  const_named_tables
  const_table
Stores an immutable (read-only) collection of attribute arrays (named arrays with identical lengths).
  const_typed_array_bool_t
Stores an immutable (read-only) collection of boolean values.
  const_typed_array_color
Stores an immutable (read-only) collection of color values.
  const_typed_array_double_t
Stores an immutable (read-only) collection of floating-point values.
  const_typed_array_imaterial
Stores an immutable (read-only) collection of imaterial objects.
  const_typed_array_inode
Stores an immutable (read-only) collection of inode objects.
  const_typed_array_int16_t
Stores an immutable (read-only) collection of 16-bit integer values.
  const_typed_array_int32_t
Stores an immutable (read-only) collection of 32-bit integer values.
  const_typed_array_int64_t
Stores an immutable (read-only) collection of 64-bit integer values.
  const_typed_array_int8_t
Stores an immutable (read-only) collection of 8-bit integer values.
  const_typed_array_matrix4
Stores an immutable (read-only) collection of matrix4 values.
  const_typed_array_normal3
Stores an immutable (read-only) collection of normal3 values.
  const_typed_array_point2
Stores an immutable (read-only) collection of point2 values.
  const_typed_array_point3
Stores an immutable (read-only) collection of point3 values.
  const_typed_array_point4
Stores an immutable (read-only) collection of point4 values.
  const_typed_array_string_t
Stores an immutable (read-only) collection of string values.
  const_typed_array_texture3
Stores an immutable (read-only) collection of texture3 values.
  const_typed_array_uint16_t
Stores an immutable (read-only) collection of unsigned 16-bit integer values.
  const_typed_array_uint32_t
Stores an immutable (read-only) collection of unsigned 32-bit integer values.
  const_typed_array_uint64_t
Stores an immutable (read-only) collection of unsigned 64-bit integer values.
  const_typed_array_uint8_t
Stores an immutable (read-only) collection of unsigned 8-bit integer values.
  const_typed_array_vector2
Stores an immutable (read-only) collection of vector2 values.
  const_typed_array_vector3
Stores an immutable (read-only) collection of vector3 values.
  const_uint_t_array
Stores an immutable (read-only) collection of 32- or 64-bit values (depending on platform).
  cubic_curve
  cylinder
  difference
  disk
  euler
  euler_angles
Encodes a change in orientation as three rotations around mutally-perpendicular axes.
  file_change_receiver
Helper class that caches file-change notifications for later retrieval.
  file_signal
Converts file output to a C++ signal.
  filesystem
  geometry
  hyperboloid
  idocument
  iunknown
Abstract interface that represents an object with unknown capabilities.
  linear_curve
  log
  matrix4
Stores a 4x4 transformation matrix.
  mesh
Stores a heterogeneous collection of geometric mesh primitives.
  mime
  named_arrays
Stores a mutable (read-write) collection of named arrays (named arrays of varying length).
  named_tables
  node
  normal3
Stores a normal vector in three-dimensional space
  nurbs_curve
  nurbs_patch
  paraboloid
  parallel
  particle
  plugin
  point2
Stores a position in two-dimensional space
  point3
Stores a position in three-dimensional space
  point4
Stores a position in four-dimensional space
  polyhedron
Provides functionality to create and manipulate polyhedron mesh primitives.
  property
  resource
  ri
  script
  selection
  sphere
  table
Stores a mutable (read-write) collection of attribute arrays (named arrays of equal length).
  teapot
  texture3
Stores a set of three-dimensional texture coordinates
  torus
  typed_array_bool_t
Stores a mutable (read-write) collection of boolean values.
  typed_array_color
Stores a mutable (read-write) collection of color values.
  typed_array_double_t
Stores a mutable (read-write) collection of floating-point values.
  typed_array_imaterial
Stores a mutable (read-write) collection of imaterial objects.
  typed_array_inode
Stores a mutable (read-write) collection of inode objects.
  typed_array_int16_t
Stores a mutable (read-write) collection of 16-bit integer values.
  typed_array_int32_t
Stores a mutable (read-write) collection of 32-bit integer values.
  typed_array_int64_t
Stores a mutable (read-write) collection of 64-bit integer values.
  typed_array_int8_t
Stores a mutable (read-write) collection of 8-bit integer values.
  typed_array_matrix4
Stores a mutable (read-write) collection of matrix4 values.
  typed_array_normal3
Stores a mutable (read-write) collection of normal3 values.
  typed_array_point2
Stores a mutable (read-write) collection of point2 values.
  typed_array_point3
Stores a mutable (read-write) collection of point3 values.
  typed_array_point4
Stores a mutable (read-write) collection of point4 values.
  typed_array_string_t
Stores a mutable (read-write) collection of string values.
  typed_array_texture3
Stores a mutable (read-write) collection of texture values.
  typed_array_uint16_t
Stores a mutable (read-write) collection of unsigned 16-bit integer values.
  typed_array_uint32_t
Stores a mutable (read-write) collection of unsigned 32-bit integer values.
  typed_array_uint64_t
Stores a mutable (read-write) collection of unsigned 64-bit integer values.
  typed_array_uint8_t
Stores a mutable (read-write) collection of unsigned 8-bit integer values.
  typed_array_vector2
Stores a mutable (read-write) collection of vector2 values.
  typed_array_vector3
Stores a mutable (read-write) collection of vector3 values.
  uint_t_array
Stores a mutable (read-write) collection of 32- or 64-bit values (depending on platform).
  uuid
Stores a 128-bit universally unique identifier.
  vector2
Stores a direction vector in two-dimensional space
  vector3
Stores a direction vector in three-dimensional space
  vector4
Stores a direction vector in four-dimensional space
Functions [hide private]
bool :
batch_mode()
Returns True if batch (no user intervention) mode is enabled for the user interface.
 
check_node_environment(...)
check_node_environment( (context)arg1, (str)arg2) -> None : Checks to see whether the current script is running from within the given node type.
 
close_document(...)
close_document( (idocument)arg1) -> None : Closes an open document.
 
create_plugin(...)
create_plugin( (str)arg1) -> object : Creates an application plugin instance by name (fails if there is no application plugin factory with the given name).
list :
documents()
Returns a list containing all open documents.
None :
exit()
Request program exit (may be overridden by user input).
 
get_time(...)
get_time( (idocument)arg1) -> object : Returns the time property for a document (could return NULL)
matrix4 :
identity3()
Returns a L{matrix4} containing a three-dimensional identity matrix.
 
intersect_lines(...)
intersect_lines( (point3)arg1, (vector3)arg2, (point3)arg3, (vector3)arg4, (point3)arg5) -> bool : Find the point at which two infinite lines intersect.
 
inverse(...)
inverse( (matrix4)arg1) -> matrix4 : Computes the inverse of a matrix.
 
length(...)
length( (object)arg1) -> float : Returns the length of a L{vector3}.
 
log_critical(...)
log_critical( (str)arg1) -> None : Sends a critical message to the K-3D log.
 
log_debug(...)
log_debug( (str)arg1) -> None : Sends a debug message to the K-3D log.
 
log_error(...)
log_error( (str)arg1) -> None : Sends an error message to the K-3D log.
 
log_info(...)
log_info( (str)arg1) -> None : Sends an informational message to the K-3D log.
 
log_warning(...)
log_warning( (str)arg1) -> None : Sends a warning message to the K-3D log.
object :
new_document()
Returns a new (completely empty) document.
 
open_document(...)
open_document( (path)arg1) -> object : Opens an existing document stored on disk.
list :
plugins()
Returns a list containing the set of all plugin factories.
 
rotate3(...)
rotate3( (angle_axis)arg1) -> matrix4 : Returns a L{matrix4} containing a three-dimensional rotation matrix.
 
scale3(...)
scale3( (float)arg1, (float)arg2, (float)arg3) -> matrix4 : Returns a L{matrix4} containing a three-dimensional scaling matrix.
path :
share_path()
Returns the runtime path to shared data.
 
to_vector3(...)
to_vector3( (point3)arg1) -> vector3 : Explicit conversion from point3 to vector3
 
translate3(...)
translate3( (vector3)arg1) -> matrix4 : Returns a L{matrix4} containing a three-dimensional translation matrix.
object :
ui()
Returns the singleton runtime user interface plugin instance.
 
world_position(...)
world_position( (iunknown)arg1) -> point3 : Returns a node's position in world coordinates (returns the origin for non-transformable nodes)
Variables [hide private]
  __package__ = None
Function Details [hide private]

batch_mode()

 
    Returns True if batch (no user intervention) mode is enabled for the user interface.
    @note: Well-behaved scripts should not prompt the user for input if batch mode is enabled.

    C++ signature :
        bool batch_mode()

Returns: bool :

check_node_environment(...)

 

check_node_environment( (context)arg1, (str)arg2) -> None :
    Checks to see whether the current script is running from within the given node type.

    C++ signature :
        void check_node_environment(k3d::iscript_engine::context,std::string)

close_document(...)

 

close_document( (idocument)arg1) -> None :
    Closes an open document.

    C++ signature :
        void close_document(k3d::python::instance_wrapper<k3d::idocument> {lvalue})

create_plugin(...)

 

create_plugin( (str)arg1) -> object :
    Creates an application plugin instance by name (fails if there is no application plugin factory with the given name).

    C++ signature :
        boost::python::api::object create_plugin(std::string)

documents()

 
    Returns a list containing all open documents.

    C++ signature :
        boost::python::list documents()

Returns: list :

exit()

 
    Request program exit (may be overridden by user input).

    C++ signature :
        void exit()

Returns: None :

get_time(...)

 

get_time( (idocument)arg1) -> object :
    Returns the time property for a document (could return NULL)

    C++ signature :
        boost::python::api::object get_time(k3d::python::instance_wrapper<k3d::idocument> {lvalue})

identity3()

 
    Returns a L{matrix4} containing a three-dimensional identity matrix.

    C++ signature :
        k3d::matrix4 identity3()

Returns: matrix4 :

intersect_lines(...)

 

intersect_lines( (point3)arg1, (vector3)arg2, (point3)arg3, (vector3)arg4, (point3)arg5) -> bool :
    Find the point at which two infinite lines intersect.

    C++ signature :
        bool intersect_lines(k3d::point3,k3d::vector3,k3d::point3,k3d::vector3,k3d::point3 {lvalue})

inverse(...)

 

inverse( (matrix4)arg1) -> matrix4 :
    Computes the inverse of a matrix.

    C++ signature :
        k3d::matrix4 inverse(k3d::matrix4)

length(...)

 

length( (object)arg1) -> float :
    Returns the length of a L{vector3}.

    C++ signature :
        double length(boost::python::api::object)

log_critical(...)

 

log_critical( (str)arg1) -> None :
    Sends a critical message to the K-3D log.

    C++ signature :
        void log_critical(std::string)

log_debug(...)

 

log_debug( (str)arg1) -> None :
    Sends a debug message to the K-3D log.

    C++ signature :
        void log_debug(std::string)

log_error(...)

 

log_error( (str)arg1) -> None :
    Sends an error message to the K-3D log.

    C++ signature :
        void log_error(std::string)

log_info(...)

 

log_info( (str)arg1) -> None :
    Sends an informational message to the K-3D log.

    C++ signature :
        void log_info(std::string)

log_warning(...)

 

log_warning( (str)arg1) -> None :
    Sends a warning message to the K-3D log.

    C++ signature :
        void log_warning(std::string)

new_document()

 
    Returns a new (completely empty) document.

    C++ signature :
        boost::python::api::object new_document()

Returns: object :

open_document(...)

 

open_document( (path)arg1) -> object :
    Opens an existing document stored on disk.

    C++ signature :
        boost::python::api::object open_document(k3d::filesystem::path)

plugins()

 
    Returns a list containing the set of all plugin factories.

    C++ signature :
        boost::python::list plugins()

Returns: list :

rotate3(...)

 

rotate3( (angle_axis)arg1) -> matrix4 :
    Returns a L{matrix4} containing a three-dimensional rotation matrix.

    C++ signature :
        k3d::matrix4 rotate3(k3d::angle_axis)

rotate3( (euler_angles)arg1) -> matrix4 :
    Returns a L{matrix4} containing a three-dimensional rotation matrix.

    C++ signature :
        k3d::matrix4 rotate3(k3d::euler_angles)

scale3(...)

 

scale3( (float)arg1, (float)arg2, (float)arg3) -> matrix4 :
    Returns a L{matrix4} containing a three-dimensional scaling matrix.

    C++ signature :
        k3d::matrix4 scale3(double,double,double)

scale3( (float)arg1) -> matrix4 :
    Returns a L{matrix4} containing a three-dimensional scaling matrix.

    C++ signature :
        k3d::matrix4 scale3(double)

share_path()

 
    Returns the runtime path to shared data.

    C++ signature :
        k3d::filesystem::path share_path()

Returns: path :

to_vector3(...)

 

to_vector3( (point3)arg1) -> vector3 :
    Explicit conversion from point3 to vector3

    C++ signature :
        k3d::vector3 to_vector3(k3d::point3)

translate3(...)

 

translate3( (vector3)arg1) -> matrix4 :
    Returns a L{matrix4} containing a three-dimensional translation matrix.

    C++ signature :
        k3d::matrix4 translate3(k3d::vector3)

translate3( (float)arg1, (float)arg2, (float)arg3) -> matrix4 :
    Returns a L{matrix4} containing a three-dimensional translation matrix.

    C++ signature :
        k3d::matrix4 translate3(double,double,double)

translate3( (tuple)arg1) -> matrix4 :
    Returns a L{matrix4} containing a three-dimensional translation matrix.

    C++ signature :
        k3d::matrix4 translate3(boost::python::tuple)

ui()

 
    Returns the singleton runtime user interface plugin instance.

    C++ signature :
        boost::python::api::object ui()

Returns: object :

world_position(...)

 

world_position( (iunknown)arg1) -> point3 :
    Returns a node's position in world coordinates (returns the origin for non-transformable nodes)

    C++ signature :
        k3d::point3 world_position(k3d::python::instance_wrapper<k3d::iunknown> {lvalue})