https://github.com/bblanimation/custom-sculpt-mode-interface

Forces sculpt mode with Cookie Cutter interface
https://github.com/bblanimation/custom-sculpt-mode-interface

Last synced: 10 months ago
JSON representation

Forces sculpt mode with Cookie Cutter interface

• Host: GitHub
• URL: https://github.com/bblanimation/custom-sculpt-mode-interface
• Owner: bblanimation
• License: gpl-3.0
• Created: 2019-03-28T16:02:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-24T18:58:05.000Z (almost 7 years ago)
• Last Synced: 2024-05-01T12:15:41.267Z (about 2 years ago)
• Language: Python
• Size: 241 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 'Sculpt Mode Interface':

Forces sculpt mode with Cookie Cutter interface

# Instructions for Use:

* ...

# Instructions for Use as Submodule:

* The following functions can be rewritten in a subclass:

    * `self.can_start(context)`

        * returns `True` if Custom Sculpt Mode's ui and data structures can be initialized, else `False`

        * by default, this function checks the following, where `ob` is `bpy.context.active_object`: `return ob is not None and ob.type == "MESH" and bpy.context.mode == "OBJECT"`

        * must be rewritten with the `@classmethod` decorator

    * `self.ui_setup_post()`

        * called after ui elements have been declared

        * create your own ui panels and elements

        * add/edit buttons, frames, properties, etc. in the existing structure:

        ```

            self.info_panel

                self.inst_paragraphs

            self.tools_panel

                self.commit_button

                self.cancel_button

        ```

        * hide existing ui elements with the following code (replace `self.info_panel` with any ui element above): `self.info_panel.visible = False`

    * `self.start_post()`

        * called after ui and data structures have been initialized

    * `self.add_point_pre(loc)`

        * called before new point added at current mouse position

        * `loc` argument will be 2D Vector with new point's location

        * use to evaluate the existing points using the `self.b_pts` list or check custom conditions for adding new point

        * returns `True` if point can be added, else `False`

    * `self.add_point_post(new_point)`

        * called after new point added at current mouse position

        * `new_point` argument will D3Point object with the following attributes:

            * `new_point.label` = label string for point

            * `new_point.location` = 3D location Vector for point

            * `new_point.surface_normal` = 3D surface normal Vector of the object at this point's location

            * `new_point.view_direction` = 3D view direction Vector of the viewport at the time this point was placed

    * `self.move_point_post(moved_point)`

        * called after grabbed point has been placed

        * `moved_point` argument will D3Point object with the following attributes:

            * `new_point.label` = label string for point

            * `new_point.location` = 3D location Vector for point

            * `new_point.surface_normal` = 3D surface normal Vector of the object at this point's location

            * `new_point.view_direction` = 3D view direction Vector of the viewport at the time this point was placed

    * `self.end_commit()`

        * called when Points Picker is committed

        * by default, this function switches to object mode

        * must end with the following line of code: `self.end_commit_post()`

    * `self.end_commit_post()`

        * called when Points Picker is committed