robot_designer_plugin.operators.segments module

Sphinx-autodoc tag

class robot_designer_plugin.operators.segments.AssignParentSegment[source]

Bases: robot_designer_plugin.core.operators.RDOperator

operator for assigning a parent to a segment.

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

bl_idname: str = 'robotdesigner.assignparentbone'
Type

str

bl_label: str = 'Assign Parent Bone'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

parent_name: None
classmethod run(parent_name)[source]

Enables to run an operator by calling its class object. Child classes should override this method with keywords. Then your IDE will be able to assist you The pass_keywords() function makes overriding very convenient (just copy the method’s body):

In addition, this method also does extensive error and exception handling writing everything to the log file (see logfile).

Parameters

kwargs – The keyword arguments passed to the Operator (must match the names of the class’s attributes (only of type :class:`bpy.types.Property).

Returns

The return values of bpy.types.Operator.execute().

class robot_designer_plugin.operators.segments.ConvertVertexMapSkinning[source]

Bases: robot_designer_plugin.core.operators.RDOperator

operator Operator for converting vertex weight based skinning to use of the bone parent property. Bone parent will be assigned to the bone with the largest total weight. Vertex weighting will be disabled on the mesh.

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

allow_connect_to_that_bone(bone, obj)[source]
allow_connect_to_that_bone_because_vertex_weight(bone, obj)[source]

There can only be one parent_bone. So in case of multiple VG’s we have to decide which one to take.

bl_idname: str = 'robotdesigner.convert_vertexmap_skinning'
Type

str

bl_label: str = 'Assign Selected Bones Via Vertex Maps'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

execute_on_bone(bone, armature, context)[source]
stop_vertex_group_from_interfering(armature, obj, context)[source]
class robot_designer_plugin.operators.segments.CreateNewSegment[source]

Bases: robot_designer_plugin.core.operators.RDOperator

Operator for creating new robot segments and add it to the current model. If a segment is already selected, the new segment is added as a child segment. A call SelectSegment before might be necessary.

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

bl_idname: str = 'robotdesigner.create_segment'
Type

str

bl_label: str = 'Create New Segment'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

invoke(context, event)[source]

Invoke the operator

Parameters

  • context ('Context') –

  • event ('Event') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

classmethod run(segment_name)[source]

Enables to run an operator by calling its class object. Child classes should override this method with keywords. Then your IDE will be able to assist you The pass_keywords() function makes overriding very convenient (just copy the method’s body):

In addition, this method also does extensive error and exception handling writing everything to the log file (see logfile).

Parameters

kwargs – The keyword arguments passed to the Operator (must match the names of the class’s attributes (only of type :class:`bpy.types.Property).

Returns

The return values of bpy.types.Operator.execute().

segment_name: None
class robot_designer_plugin.operators.segments.DeleteSegment[source]

Bases: robot_designer_plugin.core.operators.RDOperator

operator for deleting a the selected segment ALL of its children.

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

bl_idname: str = 'robotdesigner.deletebone'
Type

str

bl_label: str = 'Delete Segment And ALL Its Children'
Type

str

confirmation: None
execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

invoke(context, event)[source]

Invoke the operator

Parameters

  • context ('Context') –

  • event ('Event') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

class robot_designer_plugin.operators.segments.ImportBlenderArmature[source]

Bases: robot_designer_plugin.core.operators.RDOperator

Set pose properties and mark all selected bones as known to the robot designer.

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

bl_idname: str = 'robotdesigner.importnative'
Type

str

bl_label: str = '(Re)Import Bones'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

execute_on_bone(bone)[source]
class robot_designer_plugin.operators.segments.InsertNewParentSegment[source]

Bases: robot_designer_plugin.core.operators.RDOperator

operator for create new parent segment for the currently selected segment.

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

bl_idname: str = 'robotdesigner.createparentbone'
Type

str

bl_label: str = 'Create New Parent Bone'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

invoke(context, event)[source]

Invoke the operator

Parameters

  • context ('Context') –

  • event ('Event') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

classmethod run(segment_name)[source]

Enables to run an operator by calling its class object. Child classes should override this method with keywords. Then your IDE will be able to assist you The pass_keywords() function makes overriding very convenient (just copy the method’s body):

In addition, this method also does extensive error and exception handling writing everything to the log file (see logfile).

Parameters

kwargs – The keyword arguments passed to the Operator (must match the names of the class’s attributes (only of type :class:`bpy.types.Property).

Returns

The return values of bpy.types.Operator.execute().

segment_name: None
class robot_designer_plugin.operators.segments.RenameSegment[source]

Bases: robot_designer_plugin.core.operators.RDOperator

operator for renaming an active bone

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

bl_idname: str = 'robotdesigner.rename_segment'
Type

str

bl_label: str = 'Rename Active Segment'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

invoke(context, event)[source]

Invoke the operator

Parameters

  • context ('Context') –

  • event ('Event') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

new_name: None
classmethod run(new_name='')[source]

Enables to run an operator by calling its class object. Child classes should override this method with keywords. Then your IDE will be able to assist you The pass_keywords() function makes overriding very convenient (just copy the method’s body):

In addition, this method also does extensive error and exception handling writing everything to the log file (see logfile).

Parameters

kwargs – The keyword arguments passed to the Operator (must match the names of the class’s attributes (only of type :class:`bpy.types.Property).

Returns

The return values of bpy.types.Operator.execute().

class robot_designer_plugin.operators.segments.SelectSegment[source]

Bases: robot_designer_plugin.core.operators.RDOperator

Operator for selecting a segment. If segment_name is empty, all segments will be deselected

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

bl_idname: str = 'robotdesigner.select_segment'
Type

str

bl_label: str = 'Select Segment'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

classmethod run(segment_name='')[source]

Enables to run an operator by calling its class object. Child classes should override this method with keywords. Then your IDE will be able to assist you The pass_keywords() function makes overriding very convenient (just copy the method’s body):

In addition, this method also does extensive error and exception handling writing everything to the log file (see logfile).

Parameters

kwargs – The keyword arguments passed to the Operator (must match the names of the class’s attributes (only of type :class:`bpy.types.Property).

Returns

The return values of bpy.types.Operator.execute().

segment_name: None
class robot_designer_plugin.operators.segments.SetDefaultJointName[source]

Bases: robot_designer_plugin.core.operators.RDOperator

operator for setting joint name to a default name

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

bl_idname: str = 'robotdesigner.default_joint_name'
Type

str

bl_label: str = 'Set Joint Name to Default Name'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

class robot_designer_plugin.operators.segments.SetDefaultJointNameAll[source]

Bases: robot_designer_plugin.core.operators.RDOperator

operator for setting joint name to a default name for all segments

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

Preconditions:

bl_idname: str = 'robotdesigner.default_joint_name_all'
Type

str

bl_label: str = 'Set Joint Name to Default Name for All Segments'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

class robot_designer_plugin.operators.segments.UpdateSegments[source]

Bases: robot_designer_plugin.core.operators.RDOperator

operator for updating the robot models after parameters changed. If a segment name is given it will proceed recursively.

Automatically registered to robot_designer_plugin.core.pluginmanager.Pluginmanager

bl_idname: str = 'robotdesigner.udpate_model'
Type

str

bl_label: str = 'Update Model'
Type

str

execute(context)

Execute the operator

Parameters

context ('Context') –

Return type

Union[Set[str], Set[int]]

Returns

result * RUNNING_MODAL Running Modal, Keep the operator running with blender. * CANCELLED Cancelled, The operator exited without doing anything, so no undo entry should be pushed. * FINISHED Finished, The operator exited after completing its action. * PASS_THROUGH Pass Through, Do nothing and pass the event on. * INTERFACE Interface, Handled but not executed (popup menus).

recurse: None
segment_name: None