Home       Trees       Indices       Help   
Package bpy :: Package ops :: Module uv
[hide private]
[frames] | no frames]

Module uv

Functions [hide private]
 
align(axis='ALIGN_AUTO')
Align selected UV vertices to an axis.
 
average_islands_scale()
(undocumented operator)
 
circle_select(x=0, y=0, radius=0, gesture_mode=0)
Select UV vertices using circle selection.
 
cube_project(cube_size=1.0, correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False)
(undocumented operator)
 
cursor_set(location=(0.0, 0.0))
Set 2D cursor location.
 
cylinder_project(direction='VIEW_ON_EQUATOR', align='POLAR_ZX', radius=1.0, correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False)
(undocumented operator)
 
hide(unselected=False)
Hide (un)selected UV vertices.
 
minimize_stretch(fill_holes=True, blend=0.0, iterations=0)
DOC_BROKEN
 
pack_islands()
(undocumented operator)
 
pin(clear=False)
Set/clear selected UV vertices as anchored between multiple unwrap operations.
 
project_from_view(orthographic=False, correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False)
(undocumented operator)
 
reset()
(undocumented operator)
 
reveal()
Reveal all hidden UV vertices.
 
select(extend=False, location=(0.0, 0.0))
Select UV vertice.
 
select_all(action='TOGGLE')
Change selection of all UV vertices.
 
select_border(pinned=False, gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)
Select UV vertices using border selection.
 
select_inverse()
Select inverse of (un)selected UV vertices.
 
select_linked(extend=False)
Select all UV vertices linked to the active UV map.
 
select_loop(extend=False, location=(0.0, 0.0))
Select a loop of connected UV vertices.
 
select_pinned()
Select all pinned UV vertices.
 
smart_project(angle_limit=66.0, island_margin=0.0)
This script projection unwraps the selected faces of a mesh.
 
snap_cursor(target='PIXELS')
Snap cursor to target type.
 
snap_selection(target='PIXELS')
Snap selected UV vertices to target type.
 
sphere_project(direction='VIEW_ON_EQUATOR', align='POLAR_ZX', correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False)
(undocumented operator)
 
stitch(use_limit=True, limit=0.01)
Stitch selected UV vertices by proximity.
 
tile_set(tile=(0, 0))
Set UV image tile coordinates.
 
unlink_selection()
Unlink selected UV vertices from active UV map.
 
unwrap(method='ANGLE_BASED', fill_holes=True, correct_aspect=True)
(undocumented operator)
 
weld()
Weld selected UV vertices together.
Function Details [hide private]

align(axis='ALIGN_AUTO')

 

Align selected UV vertices to an axis.

Parameters:
  • axis (enum) - Axis to align UV locations on. in (ALIGN_AUTO, ALIGN_X, ALIGN_Y)

circle_select(x=0, y=0, radius=0, gesture_mode=0)

 

Select UV vertices using circle selection.

Parameters:
  • x (int) - in (-inf, inf)
  • y (int) - in (-inf, inf)
  • radius (int) - in (-inf, inf)
  • gesture_mode (int) - in (-inf, inf)

cube_project(cube_size=1.0, correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False)

 

(undocumented operator)

Parameters:
  • cube_size (float) - Size of the cube to project on. in (0, inf)
  • clip_to_bounds (boolean)
  • correct_aspect (boolean)
  • scale_to_bounds (boolean)

cursor_set(location=(0.0, 0.0))

 

Set 2D cursor location.

Parameters:
  • location (float array of 2 items) - Cursor location in 0.0-1.0 coordinates. in (-inf, inf)

cylinder_project(direction='VIEW_ON_EQUATOR', align='POLAR_ZX', radius=1.0, correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False)

 

(undocumented operator)

Parameters:
  • direction (enum) - Direction of the sphere or cylinder. in (VIEW_ON_EQUATOR, VIEW_ON_POLES, ALIGN_TO_OBJECT)
  • align (enum) - How to determine rotation around the pole. in (POLAR_ZX, POLAR_ZY)
  • radius (float) - Radius of the sphere or cylinder. in (0, inf)
  • scale_to_bounds (boolean)
  • correct_aspect (boolean)
  • clip_to_bounds (boolean)

hide(unselected=False)

 

Hide (un)selected UV vertices.

Parameters:
  • unselected (boolean)

minimize_stretch(fill_holes=True, blend=0.0, iterations=0)

 

DOC_BROKEN

Parameters:
  • blend (float) - Blend factor between stretch minimized and original. in (0, 1)
  • iterations (int) - Number of iterations to run, 0 is unlimited when run interactively. in (0, inf)
  • fill_holes (boolean)

pin(clear=False)

 

Set/clear selected UV vertices as anchored between multiple unwrap operations.

Parameters:
  • clear (boolean)

project_from_view(orthographic=False, correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False)

 

(undocumented operator)

Parameters:
  • scale_to_bounds (boolean)
  • correct_aspect (boolean)
  • clip_to_bounds (boolean)
  • orthographic (boolean)

select(extend=False, location=(0.0, 0.0))

 

Select UV vertice.

Parameters:
  • location (float array of 2 items) - Mouse location in normalized coordinates, 0.0 to 1.0 is within the image bounds. in (-inf, inf)
  • extend (boolean)

select_all(action='TOGGLE')

 

Change selection of all UV vertices.

Parameters:
  • action (enum) - Selection action to execute in (TOGGLE, SELECT, DESELECT, INVERT)

select_border(pinned=False, gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)

 

Select UV vertices using border selection.

Parameters:
  • gesture_mode (int) - in (-inf, inf)
  • xmin (int) - in (-inf, inf)
  • xmax (int) - in (-inf, inf)
  • ymin (int) - in (-inf, inf)
  • ymax (int) - in (-inf, inf)
  • pinned (boolean)

select_linked(extend=False)

 

Select all UV vertices linked to the active UV map.

Parameters:
  • extend (boolean)

select_loop(extend=False, location=(0.0, 0.0))

 

Select a loop of connected UV vertices.

Parameters:
  • location (float array of 2 items) - Mouse location in normalized coordinates, 0.0 to 1.0 is within the image bounds. in (-inf, inf)
  • extend (boolean)

smart_project(angle_limit=66.0, island_margin=0.0)

 

This script projection unwraps the selected faces of a mesh. it operates on all selected mesh objects, and can be used unwrap selected faces, or all faces.

Parameters:
  • angle_limit (float) - lower for more projection groups, higher for less distortion. in (1, 89)
  • island_margin (float) - Margin to reduce bleed from adjacent islands. in (0, 1)

snap_cursor(target='PIXELS')

 

Snap cursor to target type.

Parameters:
  • target (enum) - Target to snap the selected UV's to. in (PIXELS, SELECTION)

snap_selection(target='PIXELS')

 

Snap selected UV vertices to target type.

Parameters:
  • target (enum) - Target to snap the selected UV's to. in (PIXELS, CURSOR, ADJACENT_UNSELECTED)

sphere_project(direction='VIEW_ON_EQUATOR', align='POLAR_ZX', correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False)

 

(undocumented operator)

Parameters:
  • direction (enum) - Direction of the sphere or cylinder. in (VIEW_ON_EQUATOR, VIEW_ON_POLES, ALIGN_TO_OBJECT)
  • align (enum) - How to determine rotation around the pole. in (POLAR_ZX, POLAR_ZY)
  • scale_to_bounds (boolean)
  • correct_aspect (boolean)
  • clip_to_bounds (boolean)

stitch(use_limit=True, limit=0.01)

 

Stitch selected UV vertices by proximity.

Parameters:
  • limit (float) - Limit distance in normalized coordinates. in (0, inf)
  • use_limit (boolean)

tile_set(tile=(0, 0))

 

Set UV image tile coordinates.

Parameters:
  • tile (int array of 2 items) - Tile coordinate. in (0, inf)

unwrap(method='ANGLE_BASED', fill_holes=True, correct_aspect=True)

 

(undocumented operator)

Parameters:
  • method (enum) - Unwrapping method. Angle Based usually gives better results than Conformal, while being somewhat slower. in (ANGLE_BASED, CONFORMAL)
  • fill_holes (boolean)
  • correct_aspect (boolean)

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Dec 9 12:15:46 2009 http://epydoc.sourceforge.net