master surface

Used for master surface operations.


xshade
shape
master_surface

List of Methods

file_exists Whether the external reference file exists or not
has_external_reference Whether or not the external reference file itself has an external reference file
unlink_external_reference Unlinks the external reference file
update_external_reference Updates the external reference file

List of Properties

actual_size Whether it is an external reference file or not
actual_size_mode The path of the external reference file




Used after selecting a master surface object and getting the master surface with a method such as xshade.scene().active_shape().

Method Details

file_exists

Whether the external reference file exists or not.
Return value :
  bool

print xshade.scene().active_shape().file_exists()

has_external_reference

Whether or not the external reference file itself has an external reference file.
Return value :
  bool

print xshade.scene().active_shape().has_external_reference()

unlink_external_reference

Unlinks the external reference file.
Arguments :
  bool : True : Displays a confirmation dialog; False : No confirmation dialog

xshade.scene().active_shape().unlink_external_reference(True)

update_external_reference

Updates the external reference file.
Return value :
  bool
See also :
  object_info_view Object Info Window
  surface_view Surface Window
If the Surface Window or Object Info Window are displayed, they must be updated.

#Update the external reference file, and then update the Surface and Object Info windows
xshade.scene().active_shape().update_external_reference()
xshade.surface_view().update()
xshade.object_info_view().update()

Property Details

external_reference

Whether it is an external reference file or not.

  • Get
  • Set

Type :
  bool

print xshade.scene().active_shape().external_reference

path

The path of the external reference file.

  • Get
  • Set

Type :
  file_path
Settings are not reflected unless updated with update_external_reference.

print xshade.scene().active_shape().path