Warning

This is a reference for integrations with Blender’s UI and not typically useful for third party plugins.

Properties (core.properties)

class CoherenceComponentMetadata(*args: Any, **kwargs: Any)

Bases: bpy.types.

Metadata for a Coherence Component currently attached to an object

This is stored in a CollectionProperty and persisted with the object so we can restore component states when loading Coherence.

get_component()

Retrieve the component instance for this metadata properties.

Returns

Component|None

class CoherenceImageProperties(*args: Any, **kwargs: Any)

Bases: bpy.types.

error

An error with the source image that prevents syncing with Unity

Type

str, default None

texture_slot

The named texture slot to sync the active image

Type

str, default None

class CoherenceObjectProperties(*args: Any, **kwargs: Any)

Bases: bpy.types.

class CoherenceSceneProperties(*args: Any, **kwargs: Any)

Bases: bpy.types.

The primary Coherence connection settings

connection_name

Shared connection name that matches with Unity’s Coherence Settings window

Type

str, default Coherence

show_view3d_controls

Show the Coherence toggle button in the viewport controls menu

Type

bool, default True

texture_slot_update_frequency

How frequently (in seconds) to sync image pixel data while actively using the Image Paint tool

Type

float, default 0.05

on_toggle_component_enabled(self, context)

Callback for when the enabled property changes

texture_slot_enum_items(self, context)

Generate an EnumProperty items list from Coherence texture slots

Parameters

context (bpy.context) –

Returns

list of [(slot, slot, ‘’), …]

validate_image_for_sync(img) → str

Check if an image can be synced with Unity

Parameters

img (bpy.types.Image) –

Returns

Error message, or an empty string for no error

Return type

str

Panels (core.panels)

class BasePanel(*args: Any, **kwargs: Any)

class COHERENCE_IMAGEPAINT_PT_texture_sync(*args: Any, **kwargs: Any)

Panel in the Image Editor space to modify image sync settings

class COHERENCE_LIGHT_PT_light(*args: Any, **kwargs: Any)

Panel to disable most light settings as Blender lights are not supported by default

class COHERENCE_MATERIAL_PT_settings(*args: Any, **kwargs: Any)

class COHERENCE_OBJECT_PT_components(*args: Any, **kwargs: Any)

class COHERENCE_PT_context_material(*args: Any, **kwargs: Any)

Panel based on CYCLES_PT_context_material to provide a similar material selector menu

class COHERENCE_RENDER_PT_settings(*args: Any, **kwargs: Any)

Panel containing basic connection settings

class COHERENCE_RENDER_PT_settings_advanced(*args: Any, **kwargs: Any)

Panel containing advanced connection settings

draw_render_header(self, context)

Draw a toggle button below engine selection in render settings.

This callback is added to bpy.types.RENDER_PT_context on startup.

draw_view3d_header(self, context)

Draw a toggle button in the header of Blender’s View3D

This callback is added to bpy.types.VIEW3D_HT_header on startup.

Operators (core.operators)

class COHERENCE_LIST_OT_AddComponent(*args: Any, **kwargs: Any)

class COHERENCE_OT_DestroyComponent(*args: Any, **kwargs: Any)

class COHERENCE_OT_Start(*args: Any, **kwargs: Any)

Start the Coherence connection with Unity

class COHERENCE_OT_Stop(*args: Any, **kwargs: Any)

Close the Coherence connection with Unity