BlenderNC Add-on API

Release: 0.6.0 Date: Dec 13, 2022

This reference manual details functions, modules, and objects included in BlenderNC. For learning how to use BlenderNC, see the complete documentation and examples.

BlenderNC API is structured in

Submodules

• blendernc.python_functions
  • BlenderncEngine
  • build_enum_prop_list()
  • dataarray_random_sampling()
  • datacube_values()
  • del_cache()
  • dict_update()
  • dict_update_tutorial_datacube()
  • empty_item()
  • is_cached()
  • load_frame()
  • normalize_data_w_grid()
  • plot_using_grid()
  • preference_frame()
  • purge_cache()
  • refresh_cache()
  • resolution_steps()
  • rgb2gray()
  • rotate_longitude()
  • select_datacube()
  • select_item()
  • ui_material()
• blendernc.get_utils
  • filter_2_string_lists()
  • get_all_materials_using_image()
  • get_all_nodes_using_image()
  • get_all_output_nodes()
  • get_blendernc_nodetrees()
  • get_colormap_connected_to_image()
  • get_colormaps_of_materials()
  • get_coord()
  • get_default_material()
  • get_dims()
  • get_geo_coord_names()
  • get_input_links()
  • get_items_axes()
  • get_items_dims()
  • get_material_links()
  • get_max_min_data()
  • get_new_id_mult_outputs()
  • get_new_identifier()
  • get_node()
  • get_output_links()
  • get_possible_dims()
  • get_possible_variables()
  • get_time()
  • get_unique_data_dict()
  • get_units_data()
  • get_var()
  • get_var_data()
  • get_var_dict()
  • get_xarray_datasets()
  • search()
• blendernc.blendernc
  • registerBlenderNC()
  • unregisterBlenderNC()
• blendernc.decorators
  • DrawDecorators
  • MathDecorator
  • MemoryDecorator
  • NodesDecorators
• blendernc.handlers
  • load_handler()
  • update_all_images()
• blendernc.preferences
  • BlenderNC_Preferences
  • add_python_path()
  • dask_client()
  • get_addon_preference()
  • import_workspace()
  • load_handler_for_startup()
  • print_error()
  • update_client()
  • update_message()
  • update_path()
  • update_workspace()
• blendernc.image
  • array_to_image()
  • dataset_2_image_preview()
  • from_data_to_pixel_value()
  • image_data()
  • normalize_data()
• blendernc.messages
  • PrintMessage
  • active_selection_preference()
  • asign_material()
  • client_exists()
  • drop_dim()
  • huge_image()
  • load_after_restart()
  • no_cached_image()
  • no_cached_nodes()
  • no_package()
  • path_no_exist()
  • required_package()
  • same_min_max_value()
  • select_file()
  • unselected_coord()
  • unselected_datacube()
  • unselected_dim()
  • unselected_object()
  • unselected_variable()
• blendernc.operators
  • BlenderNC_OT_apply_material
  • BlenderNC_OT_colorbar
  • BlenderNC_OT_compute_range
  • BlenderNC_OT_datacube2img
  • BlenderNC_OT_datacubeload
  • BlenderNC_OT_preloader
  • BlenderNC_OT_var
  • ImportDatacubeCollection
• blendernc.panels
  • BlenderNC_UI_PT_file_selection
  • BlenderNC_UI_PT_parent
  • BlenderNC_dask_client
  • BlenderNC_workspace_animation
  • BlenderNC_workspace_memory
  • BlenderNC_workspace_panel
  • item_animation()
  • item_memory_handle()
  • select_only_meshes()
• blendernc.UI_operators
  • BlenderNC_OT_Simple_UI
  • BlenderNC_OT_purge_all
  • ImportDatacubeCollection
  • Import_OT_mfdataset
  • findCommonName()
  • name_match()
• blendernc.sockets
  • bNCSocketDefault
  • bNCdatacubeSocket
  • bNCfloatSocket
  • bNCstringSocket

Core

• blendernc.core package
  • blendernc.core.dates
  • blendernc.core.logging

Nodes

• blendernc.nodes
  • blendernc.nodes.shortcuts
  • blendernc.nodes.inputs
  • blendernc.nodes.cmaps
  • blendernc.nodes.math
  • blendernc.nodes.selecting
  • blendernc.nodes.grid
  • blendernc.nodes.outputs
• blendernc.nodes utils:
  • blendernc.nodes.BlenderNC_NT_node_template
  • blendernc.nodes.node_categories
  • blendernc.nodes.node_tree

Module

blendernc.register()

register Register all BlenderNC functions into Blender

blendernc.unregister()

unregister Unregister all BlenderNC functions into Blender