shade

Basic class for accessing Shade data.


xshade
shade

List of Properties

active_document The path to the currently active document
aggregate_window_shown Whether the Aggregate Window is displayed or not
background_window_shown Whether the Background Window is displayed or not
bits Shade's number of bits
browser_window_shown Whether the Browser is displayed or not
build_date Shade's build date
camera_window_shown Whether the Camera Window is displayed or not
color_window_shown Whether the Color Window is displayed or not
correction_window_shown Whether the Color Correction Window is displayed or not
current_background_texture The layer number of the currently selected background
distant_light_window_shown Whether the Distant Light Window is displayed or not
image_window_shown Whether the Image Window is displayed or not
max_used_memory The maximum used memory
meshtools_window_shown Whether the Mesh Tools Window is displayed or not
message_window_shown Whether the Message Window is displayed or not
motion_window_shown Whether the Motion Window is displayed or not
path The Shade application path
processor The processor of the machine being used
radiosity_window_shown Whether the Radiosity Window is displayed or not
relative Whether relative coordinates are on/off
renderers The tuple of the names of the implemented renderers
ruler_window_shown Whether the Ruler Window is displayed or not
script_path The path of the currently running script file
script_window_shown Whether the Script Window is displayed or not
scripts_path The path of the Scripts folder
shadeexplorer_window_shown Whether ShadeExplorer is displayed or not
shortcut_window_shown Whether the Shortcut Window is displayed or not
skin_window_shown Whether the Skin Window is displayed or not
smooth_apply Whether Smooth is on/off
special_characters The string of all special characters used for things such as Boolean operations
surface_window_shown Whether the Surface Window is displayed or not
tool_box_window_shown Whether the Toolbox is displayed or not
used_memory The used memory
version Shade's version number
version_info Shade's version, grade, and build number




Property Details

active_document

The path to the currently active document.

  • Get
  • Set

Type :
  file_path
Only valid for saved documents.

print xshade.shade().active_document

aggregate_window_shown

Whether the Aggregate Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().aggregate_window_shown

background_window_shown

Whether the Background Window is displayed or not.

  • Get
  • Set

Type :
  bool
Only valid when detached from the Aggregate Window.
If set to True when attached to the Aggregate Window, an empty window opens.

print xshade.shade().background_window_shown

bits

Shade's number of bits.

  • Get
  • Set

Type :
  int : 32, 64

print xshade.shade().bits

browser_window_shown

Whether the Browser is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().browser_window_shown

camera_window_shown

Whether the Camera Window is displayed or not.

  • Get
  • Set

Type :
  bool
Only valid when detached from the Aggregate Window.
If set to True when attached to the Aggregate Window, an empty window opens.

print xshade.shade().camera_window_shown

build_date

Shade's build date.

  • Get
  • Set

Type :
  int : yyyymmdd

print xshade.shade().build_date

color_window_shown

Whether the Color Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().color_window_shown

correction_window_shown

Whether the Color Correction Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().correction_window_shown

current_background_texture

The layer number of the currently selected background.

  • Get
  • Set

Type :
  int

print xshade.shade().current_background_texture

distant_light_window_shown

Whether the Distant Light Window is displayed or not.

  • Get
  • Set

Type :
  bool
Only valid when detached from the Aggregate Window.
If set to True when attached to the Aggregate Window, an empty window opens.

print xshade.shade().distant_light_window_shown

image_window_shown

Whether the Image Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().image_window_shown

max_used_memory

The maximum used memory.

  • Get
  • Set

Type :
  int

print xshade.shade().max_used_memory

meshtools_window_shown

Whether the Mesh Tools Window is displayed or not.

  • Get
  • Set

Type :
  bool
False if the Mesh Tools are integrated into the Toolbox.

print xshade.shade().meshtools_window_shown

message_window_shown

Whether the Message Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().message_window_shown

motion_window_shown

Whether the Motion Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().motion_window_shown

path

The Shade application path.

  • Get
  • Set

Type :
  file_path

print xshade.shade().path

processor

The processor of the machine being used.

  • Get
  • Set

Type :
  string : IA: Intel Architecture, PPC: PowerPC

print xshade.shade().processor

radiosity_window_shown

Whether the Radiosity Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().radiosity_window_shown

relative

Whether relative coordinates are on/off.

  • Get
  • Set

Type :
  bool

print xshade.shade().relative

renderers

The tuple of the names of the implemented renderers.

  • Get
  • Set

Type:
  string tuple

print xshade.shade().renderers

ruler_window_shown

Whether the Ruler Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().ruler_window_shown

script_path

The path of the currently running script file.

  • Get
  • Set

Type:
  file_path

print xshade.shade().script_path

script_window_shown

Whether the Script Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().script_window_shown

scripts_path

The path of the Scripts folder.

  • Get
  • Set

Type:
  file_path

print xshade.shade().scripts_path

shadeexplorer_window_shown

Whether ShadeExplorer is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().shadeexplorer_window_shown

shortcut_window_shown

Whether the Shortcut Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().shortcut_window_shown

skin_window_shown

Whether the Skin Window is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().skin_window_shown

smooth_apply

Whether Smooth is on/off.

  • Get
  • Set

Type :
  bool
Applies Smooth laterally.

print xshade.shade().smooth_apply

special_characters

The string of all special characters used for things such as Boolean operations.

  • Get
  • Set

Type :
  string
See also :
  shape.has_special_character() Whether the object is using a given special character

print xshade.shade().special_characters

surface_window_shown

Whether the Surface Window is displayed or not.

  • Get
  • Set

Type :
  bool
Only valid when detached from the Aggregate Window.
If set to True when attached to the Aggregate Window, an empty window opens.

print xshade.shade().surface_window_shown

tool_box_window_shown

Whether the Toolbox is displayed or not.

  • Get
  • Set

Type :
  bool

print xshade.shade().tool_box_window_shown

used_memory

The used memory.

  • Get
  • Set

Type :
  int

print xshade.shade().used_memory

version

Shade's version number.

  • Get
  • Set

Type :
  int

print xshade.shade().version

version_info

Shade's version, grade, and build number.

  • Get
  • Set

Type :
  string

print xshade.shade().version_info