rfm2  22.0
A python-based rewrite of RenderMan for Maya
rfm2.utils.playblast.PlayBlastOptions Class Reference
+ Inheritance diagram for rfm2.utils.playblast.PlayBlastOptions:
+ Collaboration diagram for rfm2.utils.playblast.PlayBlastOptions:

Public Member Functions

def __init__ (self, show_ui=True)
 
def __del__ (self)
 
def overrideGlobals (self)
 
def load_pref (self, name, default=None)
 
def save_pref (self, *args)
 
def cond_enabled (self, ctls, expr, opt, val)
 
def format_changed (self, ctl_comp, ctl_qlty, value)
 
def encoding_changed (self, ctl_fmt, ctl_comp, ctl_qlty, value)
 
def save_encoding (self, value)
 
def load_encoding (self)
 
def viewer_options (self)
 
def build_ui (self)
 
def show (self)
 
def options (self)
 
def view (self, filepath)
 

Public Attributes

 rfmPlayBlastSamples
 
 rfmPlayBlastVariance
 
 rfmPlayBlastView
 
 rfmPlayBlastSequence
 
 rfmPlayBlastOrnaments
 
 rfmPlayBlastFormat
 
 rfmPlayBlastQuality
 
 rfmPlayBlastPadding
 
 rfmPlayBlastRemoveTemp
 
 rfmPlayBlastSaveToFile
 
 rfmPlayBlastMovieFile
 
 rfmPlayBlastCameraSetupMEL
 
 rfmPlayBlastCameraSetupID
 
 show_ui
 
 user_cmd
 
 user_cmd_name
 
 user_cmd_output
 
 overrides
 

Detailed Description

Encapsulates UI and prefs

Constructor & Destructor Documentation

◆ __init__()

def rfm2.utils.playblast.PlayBlastOptions.__init__ (   self,
  show_ui = True 
)

◆ __del__()

def rfm2.utils.playblast.PlayBlastOptions.__del__ (   self)
+ Here is the call graph for this function:

Member Function Documentation

◆ build_ui()

def rfm2.utils.playblast.PlayBlastOptions.build_ui (   self)
create the contents of the dialog.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cond_enabled()

def rfm2.utils.playblast.PlayBlastOptions.cond_enabled (   self,
  ctls,
  expr,
  opt,
  val 
)
conditionaly enable/disable controls.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ encoding_changed()

def rfm2.utils.playblast.PlayBlastOptions.encoding_changed (   self,
  ctl_fmt,
  ctl_comp,
  ctl_qlty,
  value 
)
called when the playblast compression is changed by the user.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ format_changed()

def rfm2.utils.playblast.PlayBlastOptions.format_changed (   self,
  ctl_comp,
  ctl_qlty,
  value 
)
called when the playblast format is changed by the user.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ load_encoding()

def rfm2.utils.playblast.PlayBlastOptions.load_encoding (   self)
load the choosen encoding with regards to selected format.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ load_pref()

def rfm2.utils.playblast.PlayBlastOptions.load_pref (   self,
  name,
  default = None 
)
load the last value of a given pref.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ options()

def rfm2.utils.playblast.PlayBlastOptions.options (   self)
Returns the playblast arguments as a dict.
+ Here is the call graph for this function:

◆ overrideGlobals()

def rfm2.utils.playblast.PlayBlastOptions.overrideGlobals (   self)
Override render settings for the playblast's duration.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ save_encoding()

def rfm2.utils.playblast.PlayBlastOptions.save_encoding (   self,
  value 
)
Save the choosen encoding with regards to selected format.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ save_pref()

def rfm2.utils.playblast.PlayBlastOptions.save_pref (   self,
args 
)
save the value of a given pref.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ show()

def rfm2.utils.playblast.PlayBlastOptions.show (   self)
Display the dialog. If OK is selected, override render settings,
otherwise revert prefs to their original values.
+ Here is the call graph for this function:

◆ view()

def rfm2.utils.playblast.PlayBlastOptions.view (   self,
  filepath 
)
Launch the viewer if it is not directly supported by Maya.
+ Here is the call graph for this function:

◆ viewer_options()

def rfm2.utils.playblast.PlayBlastOptions.viewer_options (   self)
Returns a list of viewers, with an option to define custom ones via
self.user_cmd and self.user_cmd_name.
+ Here is the caller graph for this function:

Member Data Documentation

◆ overrides

rfm2.utils.playblast.PlayBlastOptions.overrides

◆ rfmPlayBlastCameraSetupID

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastCameraSetupID

◆ rfmPlayBlastCameraSetupMEL

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastCameraSetupMEL

◆ rfmPlayBlastFormat

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastFormat

◆ rfmPlayBlastMovieFile

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastMovieFile

◆ rfmPlayBlastOrnaments

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastOrnaments

◆ rfmPlayBlastPadding

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastPadding

◆ rfmPlayBlastQuality

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastQuality

◆ rfmPlayBlastRemoveTemp

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastRemoveTemp

◆ rfmPlayBlastSamples

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastSamples

◆ rfmPlayBlastSaveToFile

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastSaveToFile

◆ rfmPlayBlastSequence

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastSequence

◆ rfmPlayBlastVariance

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastVariance

◆ rfmPlayBlastView

rfm2.utils.playblast.PlayBlastOptions.rfmPlayBlastView

◆ show_ui

rfm2.utils.playblast.PlayBlastOptions.show_ui

◆ user_cmd

rfm2.utils.playblast.PlayBlastOptions.user_cmd

◆ user_cmd_name

rfm2.utils.playblast.PlayBlastOptions.user_cmd_name

◆ user_cmd_output

rfm2.utils.playblast.PlayBlastOptions.user_cmd_output

The documentation for this class was generated from the following file: