vtool.util
----------

.. toctree::
    :maxdepth: 2


.. currentmodule:: vtool.util


.. rubric:: Class Summary


.. autosummary::
    :toctree:

    StopWatch
    VectorBase
    Vector2D
    Vector
    BoundingBox
    Variable
    Part
    FindUniqueString
    QuickSort

.. rubric:: Function Summary


.. autosummary::

    initialize_env
    set_env
    get_env
    add_to_PYTHONPATH
    profiler_event
    activate_profiler
    try_pass
    is_in_maya
    has_shotgun_api
    has_shotgun_tank
    get_current_maya_location
    is_in_nuke
    is_linux
    is_windows
    get_maya_version
    break_signaled
    vector_multiply
    vector_divide
    vector_magnitude
    vector_add
    vector_cross
    rotate_x_at_origin
    rotate_y_at_origin
    rotate_z_at_origin
    get_axis_vector
    fade_sine
    fade_cosine
    fade_smoothstep
    fade_sigmoid
    set_percent_range
    get_distance
    get_distance_2D
    get_magnitude_2D
    get_dot_product
    get_dot_product_2D
    get_average
    get_midpoint
    get_inbetween_vector
    get_simple_center_vector
    is_the_same_number
    convert_to_sequence
    line_side
    closest_percent_on_line_3D
    closest_percent_on_line_2D
    closest_point_to_line_2D
    convert_number_to_month
    get_current_time
    get_current_date
    get_first_number
    get_last_number
    get_end_number
    get_trailing_number
    search_first_number
    search_last_number
    replace_last_number
    increment_first_number
    increment_last_number
    find_special
    replace_string
    replace_string_at_end
    replace_string_at_start
    clean_file_string
    clean_name_string
    show_list_to_string
    show
    warning
    error
    find_possible_combos

.. rubric:: Functions

.. autofunction:: initialize_env

.. autofunction:: set_env

.. autofunction:: get_env

.. autofunction:: add_to_PYTHONPATH

.. autofunction:: profiler_event

.. autofunction:: activate_profiler

.. autofunction:: try_pass

.. autofunction:: is_in_maya

.. autofunction:: has_shotgun_api

.. autofunction:: has_shotgun_tank

.. autofunction:: get_current_maya_location

.. autofunction:: is_in_nuke

.. autofunction:: is_linux

.. autofunction:: is_windows

.. autofunction:: get_maya_version

.. autofunction:: break_signaled

.. autofunction:: vector_multiply

.. autofunction:: vector_divide

.. autofunction:: vector_magnitude

.. autofunction:: vector_add

.. autofunction:: vector_cross

.. autofunction:: rotate_x_at_origin

.. autofunction:: rotate_y_at_origin

.. autofunction:: rotate_z_at_origin

.. autofunction:: get_axis_vector

.. autofunction:: fade_sine

.. autofunction:: fade_cosine

.. autofunction:: fade_smoothstep

.. autofunction:: fade_sigmoid

.. autofunction:: set_percent_range

.. autofunction:: get_distance

.. autofunction:: get_distance_2D

.. autofunction:: get_magnitude_2D

.. autofunction:: get_dot_product

.. autofunction:: get_dot_product_2D

.. autofunction:: get_average

.. autofunction:: get_midpoint

.. autofunction:: get_inbetween_vector

.. autofunction:: get_simple_center_vector

.. autofunction:: is_the_same_number

.. autofunction:: convert_to_sequence

.. autofunction:: line_side

.. autofunction:: closest_percent_on_line_3D

.. autofunction:: closest_percent_on_line_2D

.. autofunction:: closest_point_to_line_2D

.. autofunction:: convert_number_to_month

.. autofunction:: get_current_time

.. autofunction:: get_current_date

.. autofunction:: get_first_number

.. autofunction:: get_last_number

.. autofunction:: get_end_number

.. autofunction:: get_trailing_number

.. autofunction:: search_first_number

.. autofunction:: search_last_number

.. autofunction:: replace_last_number

.. autofunction:: increment_first_number

.. autofunction:: increment_last_number

.. autofunction:: find_special

.. autofunction:: replace_string

.. autofunction:: replace_string_at_end

.. autofunction:: replace_string_at_start

.. autofunction:: clean_file_string

.. autofunction:: clean_name_string

.. autofunction:: show_list_to_string

.. autofunction:: show

.. autofunction:: warning

.. autofunction:: error

.. autofunction:: find_possible_combos