Python API 2.0 Reference
|
Public Member Functions | |
def | __init__ () |
def | arrayParameterCount () |
def | getParameter () |
def | getParameterTextureHandle () |
def | lightPath () |
def | lightType () |
def | parameterList () |
def | parameterNames () |
def | parameterSemantic () |
def | parameterType () |
Static Public Member Functions | |
def | __new__ () |
Class for providing lighting information that may be used with Viewport 2.0.
def OpenMayaRender.MLightParameterInformation.__init__ | ( | ) |
Initialize self. See help(type(self)) for accurate signature.
|
static |
Create and return a new object. See help(type) for accurate signature.
def OpenMayaRender.MLightParameterInformation.arrayParameterCount | ( | ) |
arrayParameterCount(string) -> int Return the array size of a parameter. If the parameter is not an array then a value of 0 is returned.
def OpenMayaRender.MLightParameterInformation.getParameter | ( | ) |
getParameter(int) -> MIntArraygetParameter(int) -> MFloatArraygetParameter(int) -> MMatrixgetParameter(int) -> MSamplerStateDescgetParameter(int) -> MTexturegetParameter(string) -> MIntArraygetParameter(string) -> MFloatArraygetParameter(string) -> MMatrixgetParameter(string) -> MSamplerStateDescgetParameter(string) -> MTexture Get parameter value by name or by semantic. If more than one parameter matches the semantic, the value of the first matching parameter found will be returned.
def OpenMayaRender.MLightParameterInformation.getParameterTextureHandle | ( | ) |
getParameterTextureHandle(int) -> longgetParameterTextureHandle(string) -> long Get a resource handle for a texture parameter by name or by semantic. Returns a long containing a C++ 'void' pointer which points to the resource handle.
def OpenMayaRender.MLightParameterInformation.lightPath | ( | ) |
lightPath() -> MDagPath Returns the DagPath to the scene light. Will return an unitialized DagPath for default lights.
def OpenMayaRender.MLightParameterInformation.lightType | ( | ) |
lightType() -> string Get the classification of the light node.
def OpenMayaRender.MLightParameterInformation.parameterList | ( | ) |
parameterList() -> list of string Get the names of all light parameters that are accessible.
def OpenMayaRender.MLightParameterInformation.parameterNames | ( | ) |
parameterNames(int) -> list of string Get the name of all parameters on the light which are tagged with the stock semantic.
def OpenMayaRender.MLightParameterInformation.parameterSemantic | ( | ) |
parameterSemantic(string) -> int Get the stock semantic for a named parameter: MDrawContext.kNoSemantic No semantic MDrawContext.kLightEnabled Light is enabled MDrawContext.kWorldPosition World space position MDrawContext.kWorldDirection World space direction MDrawContext.kIntensity Intensity MDrawContext.kColor Color MDrawContext.kEmitsDiffuse Emits diffuse lighting MDrawContext.kEmitsSpecular Emits specular lighting MDrawContext.kDecayRate Decay rate MDrawContext.kDropoff Dropoff MDrawContext.kCosConeAngle Cosine of the cone angle MDrawContext.kIrradianceIn Incoming irradiance MDrawContext.kShadowMap Shadow map MDrawContext.kShadowSamp Shadow map sampler MDrawContext.kShadowBias Shadow map bias MDrawContext.kShadowMapSize Shadow map size MDrawContext.kShadowViewProj Shadow map view projection matrix MDrawContext.kShadowColor Shadow color MDrawContext.kGlobalShadowOn Global toggle for whether shadows are enabled or not MDrawContext.kShadowOn Local toggle per light for whether shadows are enabled or not MDrawContext.kShadowDirty Indicates if the contents of the shadow map are out-of-date or uninitialized
def OpenMayaRender.MLightParameterInformation.parameterType | ( | ) |
parameterType(string) -> int Get the type of the named parameter, returns kInvalid if parameter is not found. MDrawContext.kInvalid Invalid element type (default value) MDrawContext.kBoolean Boolean MDrawContext.kInteger Signed 32-bit integer MDrawContext.kFloat IEEE single precision floating point MDrawContext.kFloat2 IEEE single precision floating point (x2) MDrawContext.kFloat3 IEEE single precision floating point (x3) MDrawContext.kFloat4 IEEE single precision floating point (x4) MDrawContext.kFloat4x4Row IEEE single precision floating point row-major matrix (4x4) MDrawContext.kFloat4x4Col IEEE single precision floating point column-major matrix (4x4) MDrawContext.kTexture2 2D texture MDrawContext.kSampler Sampler