Skip to content

maya_zen_tools.options

DistributionType

An enumeration of the different types of distribution that can be used when distributing vertices.

Attributes:

  • UNIFORM (str) –

    Distribute vertices equidistant along the curve or surface.

  • PROPORTIONAL (str) –

    Distribute vertices such that edge lengths are proportional to their original lengths in relation the sum of all edge lengths.

Source code in src/maya_zen_tools/options.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class DistributionType:
    """
    An enumeration of the different types of distribution that can be used
    when distributing vertices.

    Attributes:
        UNIFORM: Distribute vertices equidistant along the curve or surface.
        PROPORTIONAL: Distribute vertices such that edge lengths are
            proportional to their original lengths in relation the sum
            of all edge lengths.
    """

    UNIFORM: str = "UNIFORM"
    PROPORTIONAL: str = "PROPORTIONAL"

get_tool_options 

get_tool_options(
    tool: str,
) -> dict[str, bool | str | int | float]

Get all options for a tool.

Source code in src/maya_zen_tools/options.py 
87
88
89
90
91
92
93
def get_tool_options(
    tool: str,
) -> dict[str, bool | str | int | float]:
    """
    Get all options for a tool.
    """
    return _options.gets(tool)

get_tool_option 

get_tool_option(
    tool: str,
    option: str,
    default: float | str | bool | None = None,
) -> bool | str | float | None

Get a single option for a tool.

Source code in src/maya_zen_tools/options.py 
 96
 97
 98
 99
100
101
102
def get_tool_option(
    tool: str, option: str, default: float | str | bool | None = None
) -> bool | str | float | None:
    """
    Get a single option for a tool.
    """
    return _options.get(tool, option, default)

set_tool_options 

set_tool_options(
    tool: str,
    options_values: dict[str, bool | str | int | float],
) -> None

Set all options for a tool.

Source code in src/maya_zen_tools/options.py 
105
106
107
108
109
110
111
def set_tool_options(
    tool: str, options_values: dict[str, bool | str | int | float]
) -> None:
    """
    Set all options for a tool.
    """
    _options.sets(tool, options_values)

set_tool_option 

set_tool_option(
    tool: str, option: str, value: bool | float | str
) -> None

Set a tool option.

Source code in src/maya_zen_tools/options.py 
114
115
116
117
118
def set_tool_option(tool: str, option: str, value: bool | float | str) -> None:
    """
    Set a tool option.
    """
    _options.set(tool, option, value)