PoserPython Methods

PoserPython Methods Manual
for Windows and Mac OS X
TRADEMARK & COPYRIGHT NOTICE

Program copyright 1991-2005 Curious Labs and e frontier, Inc. All rights reserved. Interface copyright 1994-1999 Metacreations Corporation and 2000-2005 Curious Labs. All rights reserved. Curious Labs is a trademark and Poser is a registered trademark of Curious Labs and e frontier, Inc. All other trademarks or registered trademarks are the properties of their respective owners. Technology and/or code contributed by the corporate contributors listed above is owned and copyrighted by the corporate contributors. Macintosh is a registered trademark of Apple Computer, Inc. Windows is a registered trademark of Microsoft Corporation. Pentium is a registered trademark of Intel Corporation. All other product names mentioned in the manual and other documentation are used for identification purposes only and may be trademarks or registered trademarks of their respective companies. Registered and unregistered trademarks used herein are the exclusive property of their respective owners. Curious Labs, Inc. makes no claim to any such marks, nor willingly or knowingly misused or misapplied such marks. This manual as well as the software described herein is furnished under license and may only be used or copied in accordance with the terms of such license. Program copyright 1991-2005 by Curious Labs and e frontier, Inc., including the look and feel of the product. Curious Labs Poser 6 PoserPython Methods Manual copyright 2005 by Curious Labs and e frontier, Inc. No part of this document may be reproduced in any form or by any means without prior written permission of Curious Labs, Inc. Before using this software or reading this document, make sure you have read, understood, and agreed to the license contained in Poser 6 End User License Agreement (EULA) on page 9 of your Poser 6 Reference Manual.
Poser 6 - PoserPython Methods Manual
Table of Contents
TABLE OF CONTENTS
1 Running PoserPython Scripts ........................................................................... 1
The Python Scripts Palette .............................................................................................. 1 Using the Script Buttons ............................................................................................... 1 Assigning Buttons Within the Console ......................................................................... 1 Editing Scripts Within the Console ............................................................................... 2 Unassigning/Reassigning Buttons Within the Console ................................................ 2 Running Python Scripts Directly..................................................................................... 2
PoserPython Types & Methods Listing............................................................. 3

Types .................................................................................................................................. 3 Codes ................................................................................................................................. 4 Display Codes............................................................................................................... 4 Import/Export Codes..................................................................................................... 7 Language Codes ........................................................................................................ 12 Light Codes................................................................................................................. 12 Parameter Codes ....................................................................................................... 12 Callback Codes .......................................................................................................... 16 Methods ........................................................................................................................... 24 General Methods ........................................................................................................ 24 Scene Methods........................................................................................................... 27 MovieMaker Methods ................................................................................................. 50 Importer/Exporter Methods......................................................................................... 54 Animation Set Methods .............................................................................................. 57 Actor Methods............................................................................................................. 58 Figure Methods........................................................................................................... 77 Material Methods ........................................................................................................ 83 Parameter Methods .................................................................................................... 88 Geometry Methods ..................................................................................................... 94 Vertex Methods .......................................................................................................... 99 Polygon Methods...................................................................................................... 100 TexPolygon Methods................................................................................................ 102 TexVertex Methods .................................................................................................. 102
ii
Running PoserPython Scripts
1 RUNNING POSERPYTHON SCRIPTS

Poser 6 includes a simple graphical user interface that allows you to execute Python scripts by clicking a button. You can customize the Python Scripts palette and, in addition, can run Python scripts directly.
THE PYTHON SCRIPTS PALETTE

The Python Scripts palette appears as follows:
Launch the Python Scripts palette within Poser by selecting Window>Python Scripts. NOTE: Clicking some of the buttons will display a submenu of buttons within the Python Scripts palette. This is just one example of how Python scripts can be used to customize Poser. You can write scripts that will open button menus and submenus. If you are curious, you can open one of the existing submenu scripts to see how this is done.
USING THE SCRIPT BUTTONS

To run a script, simply click the desired button and the script will execute automatically.
ASSIGNING BUTTONS WITHIN THE CONSOLE

Unassigned buttons do not have a label. An ellipsis () appears in unassigned buttons to mark their availability. To assign a script to a button, simply click the mouse on the button and locate the desired script (.py file) using the standard operating system file picker. Once you have located the desired script, select it and click Open.
Running PoserPython Scripts
EDITING SCRIPTS WITHIN THE CONSOLE

You can edit scripts assigned to a Python Scripts palette button by pressing and holding [CTRL] while clicking the button assigned to the script you wish to edit. This opens the script within your operating systems default text editor for easy modification. Save your changes as appropriate for the editor you are using. Note that you may also select your own editor via the General Preferences dialog, which can be obtained by choosing Edit>General Preferences from the Poser menu.
UNASSIGNING/REASSIGNING BUTTONS WITHIN THE CONSOLE

To reassign a button to a different Python script, you must first delete its current assignment and then assign the new script to it. Do this by pressing and holding [OPTION/ALT] while clicking the button you wish to unassign. If you wish to assign the newly freed up button to a different script, do so as outlined above. Macintosh users can press [COMMAND] to reassign buttons directly.
RUNNING PYTHON SCRIPTS DIRECTLY

The Poser Scripts palette keeps your frequently used scripts close by for easy use. However, you can run any script you wish by selecting File>Run Python Script to open the standard operating system navigation dialog. Locate the script you wish to run by browsing your folders and directories, then click Open to run the script.
Types & Methods Listing
2 POSERPYTHON TYPES & METHODS LISTING

This chapter lists the custom PoserPython types, codes, constants, and methods in a tabular format. Many of these items correspond to items that are controllable from the Poser interface. Please refer to your Poser 6 Reference Manual for information on each parameter.
TYPES
A type is a category of data. Python includes several data types including IntType (integers), FloatType (floating decimal point numbers), StringType (alphanumeric), and NoneType (the type of the special constant None). The PoserPython extensions add the following data types to the standard Python types: Type
ActorType
Explanation
This type of data represents an actor within a figure or scene. Note the term actor refers to any individual item that can move, including body parts, cameras, lights, props, etc. Thus, a forearm is an actor, as is hair. A body is a figure. An animation set ClothSimulator data An option dictionary A figure within a scene FireFly renderer options data Pointer to a callback function Geometry forming part of a figure or prop Hair data A node input A Poser scene A parameter (such as scale, twist, bend, etc.) Polygons (geometry surface faces) MovieMaker data Importer/Exporter data Material data Shader Node data Shader Node Input data A ShaderTree
AnimSetType ClothSimulatorType DictType FigureType FireFlyOptionsType FunctionType GeomType HairType InputType SceneType ParmType PolygonType MovieMakerType ImExporterType MaterialType ShaderNodeType ShaderNodeInputType ShaderTreeType
Poser 6 - PoserPython Methods Manual Type

TexPolygonType TexVertType TupleType VertType Texture polygon data Texture vertices data A Tuple Vertices (points defining the edges of polygons)
Explanation
These additional data types let both you and Poser know exactly what kind of data is being manipulated and what can and cannot be done to that data.
CODES
In PoserPython, a code is a representation of a given parameter such as a coordinate, display mode, light attribute, etc. These codes make it easy to access Posers internal data and also make it easy to know which parameter is being called or set. When using them in your scripts, make sure to prefix them with poser. so that the PoserPython interpreter understands that they are predefined PoserPython member variables. For example, one might call scene.SetDisplayStyle(poser.kDisplayCodeCARTOONNOLINE) when setting the scenes display style.
CLOTH SIMULATOR CODES

These codes are used by a Cloth Simulator. They are typically used in conjunction with the DynamicsProperty() method, to return a property of the specified type. Please refer to the Poser 6.0 Reference Manual, Chapter 29: The Cloth Room for more information about Cloth Simulators.
kClothParmCodeAIRDAMPING The Air Damping parameter specifies the cloths air resistance that occurs whenever the cloth is moving through the air. kClothParmCodeCLOTHCLOTHFORCE The ClothClothForce parameter. kClothParmCodeCLOTHFRICTION The Cloth Self Friction parameter sets the coefficient of friction between one part of the cloth and another, or how easily the cloth moves over itself. kClothParmCodeDAMPINGSTRETCH The Stretch Damping parameter controls the internal energy loss caused by the motion of the cloth fibers against each other. kClothParmCodeDENSITY
The ClothDensity parameter specifies the mass-per-unit area density of the cloth in grams per square centimeter. kClothParmCodeDYNAMICFRICTION The Dynamic Friction parameter sets the coefficient of friction between the cloth and solid objects when the cloth is in motion. kClothParmCodeFRICTIONFROMSOLID Enabling Collision Friction ignores the cloth objects Static Friction and Dynamic Friction parameters, instead using those same parameters belonging to the collision objects themselves. kClothParmCodeFRICTIONVELOCITYCUTOFF The Friction Velocity Cutoff parameter sets the friction velocity cutoff value. kClothParmCodeSHEARRESISTANCE The Shear Resistance parameter controls the cloths resistance to in-plane shearing, or side-to-side bending. kClothParmCodeSPRINGRESISTANCE The Spring Resistance parameter specifies the cloths spring resistance value. kClothParmCodeSTATICFRICTION The Static Friction parameter sets the amount of friction between the cloth and solid objects. kClothParmCodeTHICKNESS The Thickness code constitutes the combination of the cloths Collision Offset and Collision Depth parameters. kClothParmCodeUBENDRATE The Bend Rate parameter operating on the U coordinate axis. kClothParmCodeUBENDRESISTANCE The Fold Resistance parameter specifies the resistance to out-of plane bending (folding). The UBendResistance code specifies the U coordinate axis of the Fold Resistance parameter. kClothParmCodeUSCALE The Scale parameter operating on the U coordinate axis. kClothParmCodeUSEEDGESPRINGS

The UseEdgeSprings parameter sets whether or not the cloth will use edge spring calculations. kClothParmCodeUSTRETCHRESISTANCE
The Stretch Resistance parameter specifies the cloths resistance to in-plane bending (stretching). The UStretchResistance code specifies the U coordinate axis of the Stretch Resistance parameter. kClothParmCodeVBENDRATE The Bend Rate parameter operating on the V coordinate axis. kClothParmCodeVBENDRESISTANCE The Fold Resistance parameter specifies the resistance to out-of plane bending (folding). The VBendResistance code specifies the V coordinate axis of the Fold Resistance parameter. kClothParmCodeVSCALE The Scale parameter operating on the V coordinate axis. kClothParmCodeVSTRETCHRESISTANCE The Stretch Resistance parameter specifies the cloths resistance to in-plane bending (stretching). The VStretchResistance code specifies the V coordinate axis of the Stretch Resistance parameter.
DIALOG CODES
Dialog codes. They are typically used in conjunction with the DialogFileChooser() method.
kDialogFileChooserOpen Brings up a standard File Open dialog window. kDialogFileChooserSave Brings up a standard File Save dialog window.
DISPLAY CODES
Display codes specify the display mode, normally set by the Display Styles palette. They are typically used in conjunction with the scene.SetDisplayStyle() method.
kDisplayCodeCARTOONNOLINE Cartoon with no line display mode. kDisplayCodeEDGESONLY Outline display mode.

kDisplayCodeFLATLINED Flat Lined display mode. kDisplayCodeFLATSHADED Flat Shaded display mode. kDisplayCodeHIDDENLINE Hidden Line display mode. kDisplayCodeSHADEDOUTLINED Shaded Outline display mode. kDisplayCodeSILHOUETTE Silhouette display mode. kDisplayCodeSKETCHSHADED Sketch Shaded display mode. kDisplayCodeSMOOTHLINED Smooth Lined display mode. kDisplayCodeSMOOTHSHADED Smooth Shaded display mode. kDisplayCodeTEXTURESHADED Texture Shaded display mode. KDisplayCodeUSEPARENTSTYLE The style of the actor/figures parent. KDisplayCodeWIREFRAME Wireframe display mode.
FIREFLY OPTIONS CODES

These FireFly Options codes specify various types of post filter algorithms, and define the pen styles used to create the toon outlines.
kOutlineCodeTHINPEN Specifies the Thin Pen toon outline style.

kOutlineCodeTHINPENCIL Specifies the Thin Pencil toon outline style. kOutlineCodeTHINMARKER Specifies the Thin Marker toon outline style. kOutlineCodeMEDIUMPEN Specifies the Medium Pen toon outline style. kOutlineCodeMEDIUMPENCIL Specifies the Medium Pencil toon outline style. kOutlineCodeMEDIUMMARKER Specifies the Medium Marker toon outline style. kOutlineCodeTHICKPEN Specifies the Thick Pen toon outline style. kOutlineCodeTHICKPENCIL Specifies the Thick Pencil toon outline style. kOutlineCodeTHICKMARKER Specifies the Thick Marker toon outline style. kPixelFilterCodeBOX Box Post Filter Type kPixelFilterCodeGAUSS Gaussian Post Filter Type kPixelFilterCodeSINC Sinc Post Filter Type
IMPORT/EXPORT CODES
The PoserPython options dictionary now includes enumerations of import and export options. These options correspond to UI option strings present in dialog boxes when importing/exporting files from within Poser 6 using the normal interface. For users who need access to the strings as they appear in the dialog boxes, you can query the strings by passing the enumeration constant into the ImportOptionString() and ExportOptionString() methods (discussed below). 8
Codes such as poser.kExOptCodeMULTIFRAME are pre-defined constants with unique identifying values. For instance,
poser.kImOptCodeCENTERED poser.kImOptCodePLACEONFLOOR poser.kImOptCodePERCENTFIGSIZE poser.kImOptCodeOFFSETX poser.kImOptCodeOFFSETY etc. = = = = = 0 1 2 3 4
The values 0 to 4 do not represent the values or choices the options are set to, but rather, they are simply codes uniquely identifying each option. It is unlikely that you will ever need to know or set them. A more typical use of import/export option enumeration values is illustrated in the following line of code:
options[poser.kExOptCodeFIRSTFRAME] = 2
The above example sets the value of the FirstFrame option to 2.

kImOptCodeCENTERED Center object kImOptCodePLACEONFLOOR Place object on floor kImOptCodePERCENTFIGSIZE Figure scale in percent kImOptCodeOFFSETX X offset amount. kImOptCodeOFFSETY Y offset amount. kImOptCodeOFFSETZ Z offset amount. kImOptCodeWELDIDENTICALVERTS Weld identical vertices. kImOptCodeMAKEPOLYNORMSCONSISTEN Make polygon normals consistent. kImOptCodeFLIPNORMS Flip normals.
kImOptCodeFLIPUTEXTCOORDS Flip U texture coordinates. kImOptCodeFLIPVTEXTCOORDS Flip V texture coordinates. kImOptCodeARMALIGNMENTAXIS Arm alignment axis kImOptCodeAUTOSCALE Automatic scaling kExOptCodeMULTIFRAME Multiple frame export. kExOptCodeFIRSTFRAME First frame of export. kExOptCodeLASTFRAME Last frame of export kExOptCodeGROUPSPERBODYPART Keep body part groups. kExOptCodeAUTOSCALE Set automatic scaling for BVH export. kExOptCodeFIGNAMESINGROUPS Keep figure names in groups. kExOptCodeBODYPARTNAMESINPOLYGROUPS Embed body part names in polygon groups. kExOptCodeEXISTIGNGROUPSINPOLYGROUPS Keep existing polygon group names. kExOptCodeWELDSEAMS Welds seams in figures/props.
10

kExOptCodeASMORPHTARGET Saves current figure/prop as a morph target. kExOptCodeUSEINTERNALNAMES Use internal names. kExOptCodeGENERATEHTML Viewpoint option generate HTML file with MTS/MTL. kExOptCodeSAVECOMPRESSED Save files in compressed format. kExOptCodeHTMLVIEWPORTWIDTH Viewpoint option HTML window width. kExOptCodeHTMLVIEWPORTHEIGHT Viewpoint option HTML window height. kExOptCodeUSEWAVELETTEXTURES Viewpoint option use wavelet textures. kExOptCodeUSEANIMSETS Viewpoint export use animation sets. kExOptCodeIGNORECAMERAANIM Viewpoint export ignores camera motions. kExOptCodeSOFTEDGESINHTML Viewpoint export soft HTML window edges kExOptCodeIMAGEQUALITY Viewpoint export image quality. kExOptCodeGEOMQUALITY Viewpoint export geometry quality. kExOptCodeSCALEFACTOR Scale exported scene by this amount. kExOptCodeBROADCASTKEY
11

Viewpoint broadcast key.
LANGUAGE CODES
Language codes are codes representing the various languages for which this copy of Poser 6 may be localized.
kLlanguageCodeUSENGLISH Sets US English as the default language. kLanguageCodeFRENCH Return value for the Poser.Language() method (described below) kLanguageCodeGERMAN Return value for the Poser.Language() method (described below) kLanguageCodeJAPANESE Return value for the Poser.Language() method (described below)
LIGHT CODES
These codes are used to set the light types. They are typically used in conjunction with the actor.SetLightType() method.
kLightCodeIMAGE Image Based light. kLightCodeINFINITE Infinite light. kLightCodeLOCAL Local light. kLightCodePOINT Point light. kLightCodeSPOT Spotlight.
PARAMETER CODES
These codes are used to specify specific Poser parameters. For example, instead of using the actor.Parameter(xTran) method, the actor.ParameterByCode(poser.kParmCodeXTRAN) can be used to return the x-axis translation parameter for the actor. 12

kParmCodeASCALE Uniform scale parameter. kParmCodeCENTER For internal Poser use only. kParmCodeCURVE Strength of bend deformation for an object using curve deformation. kParmCodeDEPTHMAPSIZE
Parameter representing the x and y depth map resolution attached to a given light. kParmCodeDEPTHMAPSTRENGTH Intensity of shadow produced from a given light. Valid values range from 0.0 to 1.0. A value of 1.0 indicates full shadow, and 0.0 indicates no shadow. kParmCodeFOCAL Camera focal length parameter. kParmCodeFOCUSDISTANCE Camera focus distance parameter (affects Depth of Field effect). kParmCodeFSTOP Camera f-stop parameter (affects Depth of Field effect). kParmCodeGEOMCHAN For objects containing more than one possible geometry, this parameter specifies which geometry to use (such as the hands in Poser 1 and 2 figures). kParmCodeGRASP Hand grasp parameter. kParmCodeHITHER Camera parameter specifying a near clipping plane distance. kParmCodeKDBLUE Blue component of the diffuse color. kParmCodeKDGREEN Green component of the diffuse color.
13
kParmCodeKDINTENSITY Uniform intensity scale of the diffuse color. kParmCodeKDRED Red component of the diffuse color. kParmCodeLITEATTENEND Light attenuation ending parameter. kParmCodeLITEATTENSTART Light attenuation starting parameter. kParmCodeLITEFALLOFFEND Ending distance for a lights falloff zone. kParmCodeLITEFALLOFFSTART Starting distance for a lights falloff zone. kParmCodePOINTAT Degree to which an actor set to point at something will actually point at it. kParmCodeSHUTTERCLOSE Shutter closing time in fractions of a frame, where 0.0 is the beginning of the frame and 1.0 is the end of the frame. (Requires 3D Motion Blur activated to see visible effect.) kParmCodeSHUTTEROPEN Shutter opening time in fractions of a frame, where 0.0 is the beginning of the frame and 1.0 is the end of the frame. (Requires 3D Motion Blur activated to see visible effect.) kParmCodeSPREAD Hand spread parameter. kParmCodeTAPERX Amount of X-axis taper for the current actor. kParmCodeTAPERY Amount of Y-axis taper for the current actor. kParmCodeTAPERZ Amount of Z-axis taper for the current actor.
14
kParmCodeTARGET Parameter controlling a morph target. kParmCodeTGRASP Hands thumb grasp parameter. kParmCodeVALUE Placeholder for a value. Usually, these values are used functionally to control other things such as full-body morphs. kParmCodeWAVEAMPLITUDE Wave objects amplitude parameter. kParmCodeWAVEAMPLITUDENOISE Wave objects amplitude noise parameter. kParmCodeWAVEFREQUENCY Wave objects frequency parameter. kParmCodeWAVELENGTH Wave objects wavelength parameter. kParmCodeWAVEOFFSET Wave objects offset parameter. kParmCodeWAVEPHASE Wave objects phase parameter. kParmCodeWAVESQUARE Wave objects square form parameter. kParmCodeWAVESINUSOIDAL Wave objects sinusoidal form parameter. kParmCodeWAVESTRETCH Wave objects stretch parameter. kParmCodeWAVETRIANGULAR Wave objects triangular form parameter.
15
kParmCodeWAVETURBULENCE Wave objects turbulence parameter. kParmCodeXROT Rotation about the X-axis. kParmCodeXSCALE Amount of scale along the X-axis kParmCodeXTRAN Translation along the X-axis. kParmCodeYON Camera parameter specifying a far clip plane distance. kParmCodeYROT Rotation about the Y-axis. kParmCodeYSCALE Amount of scale along the Y-axis. kParmCodeYTRAN Translation along the Y-axis. kParmCodeZROT Rotation about the Z-axis. kParmCodeZSCALE Amount of scale along the Z-axis kParmCodeZTRAN Translation along the Z-axis.
SCENE CODES (RENDER ENGINES)

The following scene codes specify which render engine will be used. These render engine settings may affect both scene previews and final render results, depending on how they are applied. Please refer to the Poser 6 Reference Manual, Part 7: Rendering, for more information about these render engines. In the Poser UI, these options are available on the 16
Render tab of the Document window for rendering still images, and in the Movie Settings dialog for rendering animations.
kRenderEngineCodeFIREFLY Selects the FireFly render engine. kRenderEngineCodePOSER4 Selects the Poser 4 render engine. kRenderEngineCodePREVIEW Selects the Preview render engine. kRenderEngineCodeSKETCH Selects the Sketch Designer renderer.
SHADER NODE CODES

These codes specify types of shader nodes. Please refer to the Poser 6 Reference Manual, Part 6: Materials, for more information about these shader node types.
kNodeTypeCodeAMBIENTOCCLUSION Specifies an Ambient Occlusion raytrace lighting node. kNodeTypeCodeANISOTROPIC Specifies an Anisotropic specular lighting node. kNodeTypeCodeATMOSPHERE Specifies the Root Atmosphere shader node. kNodeTypeCodeBACKGROUND Specifies the Root Background shader node. kNodeTypeCodeBLENDER Specifies a Blender math node. kNodeTypeCodeBLINN Specifies a Blinn specular lighting node. kNodeTypeCodeBRICK Specifies a Brick 2D texture node. kNodeTypeCodeCELLULAR
17

Specifies a Cellular 3D texture node. kNodeTypeCodeCLAY Specifies a Clay diffuse lighting node. kNodeTypeCodeCLOUDS Specifies a Clouds 3D texture node. kNodeTypeCodeCOLORMATH Specifies a Color Math math node. kNodeTypeCodeCOLORRAMP Specifies a Color Ramp math node. kNodeTypeCodeCOMP Specifies a Component math node. kNodeTypeCodeDIFFUSE Specifies a standard Diffuse lighting node. kNodeTypeCodeDNDU Specifies a DNDU variable node. kNodeTypeCodeDNDV Specifies a DNDV variable node. kNodeTypeCodeDPDU Specifies a DPDU variable node. kNodeTypeCodeDPDV Specifies a DPDV variable node. kNodeTypeCodeDU Specifies a DU variable node. kNodeTypeCodeDV Specifies a DV variable node. kNodeTypeCodeEDGEBLEND Specifies an Edge Blend math node.
18
kNodeTypeCodeFASTSCATTER Specifies a FastScatter special lighting node. kNodeTypeCodeFBM Specifies an FBM 3D texture node. kNodeTypeCodeFRACTALSUM Specifies a Fractal Sum 3D texture node. kNodeTypeCodeFRAME Specifies a Frame Number variable node. kNodeTypeCodeFRESNEL Specifies a Fresnel raytrace lighting node. kNodeTypeCodeGATHER Specifies a Gather raytrace lighting node. kNodeTypeCodeGLOSSY Specifies a Glossy specular lighting node. kNodeTypeCodeGRANITE Specifies a Granite 3D texture node. kNodeTypeCodeHAIR Specifies a Hair special lighting node. kNodeTypeCodeIMAGEMAP Specifies an Image Map 2D texture node. kNodeTypeCodeLIGHT Specifies a Root Light shader node. kNodeTypeCodeMARBLE Specifies a Marble 3D texture node. kNodeTypeCodeMATH Specifies a Math Function math node.
19

kNodeTypeCodeN Specifies an N variable node. kNodeTypeCodeNOISE Specifies a Noise 3D texture node. kNodeTypeCodeP Specifies a P variable node. kNodeTypeCodePHONG Specifies a Phong specular lighting node. kNodeTypeCodePOSERSURFACE Specifies the standard Poser surface root node. kNodeTypeCodePOSTERIZE
kNodeTypeCodePROBELIGHT Specifies a ProbeLight diffuse lighting node. kNodeTypeCodeREFLECT Specifies a Reflect raytrace lighting node. kNodeTypeCodeREFRACT Specifies a Refract raytrace lighting node. kNodeTypeCodeSIMPLECOLOR Specifies a Simple Color math node. kNodeTypeCodeSKIN Specifies a Skin special lighting node. kNodeTypeCodeSPECULAR Specifies a standard Specular lighting node. kNodeTypeCodeSPHEREMAP Specifies a Sphere Map environment map lighting node. kNodeTypeCodeSPOTS
20

Specifies a Spots 3D texture node. kNodeTypeCodeTILE Specifies a Tile 2D texture node. kNodeTypeCodeTOON Specifies a Toon diffuse lighting node. kNodeTypeCodeTURBULENCE Specifies a Turbulence 3D texture node. kNodeTypeCodeU Specifies a U Texture Coordinate variable node. kNodeTypeCodeUSERDEFINED Specifies a User Defined custom color math node. kNodeTypeCodeV Specifies a V Texture Coordinate variable node. kNodeTypeCodeVELVET Specifies a Velvet special lighting node. kNodeTypeCodeWAVE2D Specifies a Wave2D 2D texture node. kNodeTypeCodeWAVE3D Specifies a Wave3D 3D texture node. kNodeTypeCodeWEAVE Specifies a Weave 2D texture node. kNodeTypeCodeWOOD Specifies a Wood 3D texture node.
SHADER NODE INPUT CODES

Shader Node Input codes define the types of inputs a node can process.
kNodeInputCodeBOOLEAN A Boolean node input takes a binary True/False or On/Off value.
21
kNodeInputCodeCOLOR A Color node input takes a 4 digit RGBA color value. kNodeInputCodeFLOAT A Float node input takes 1 floating-point parameter. kNodeInputCodeINTEGER An Integer node input takes 1 integer parameter. kNodeInputCodeMENU A Menu node input takes 1 item from a list of strings. kNodeInputCodeNONE This code indicates there are no input types available. kNodeInputCodeSTRING A String node input takes 1 string parameter. kNodeInputCodeVECTOR A Vector node input takes 3 floating-point parameters.
CALLBACK CODES
A callback is a user-defined function called by the Poser code. In the following example, the callback is eventCallbackFunc. Users write this with their intended functionality then pass it back to Poser to call at the appropriate time. The constants can be used in the callback function to detect the events that occurred. For example, to test a passed back event type to see if a new actor was selected, do the following: First define a callback function:
def eventCallbackFunc(iScene, iEventType): if(iEventType & poser.kEventCodeACTORSELECTIONCHANGED): print A new actor was selected.
Now set this function to be the event callback for the scene:
scene = poser.Scene() scene.SetEventCallback(eventCallbackFunc
Now, whenever a new actor is selected, the python output window will display a message to that effect.
kCBFrameChanged not used
22
kCBSceneChanged not used kCValueChanged not used kEventCodeACTORADDED Check to see if an actor has been added. kEventCodeACTORDELETED Check to see if an actor has been deleted. kEventCodeACTORSELECTIONCHANGED Check to see if a different actor has been selected. keventCodeANIMSETSCHANGED Check to see if the animation set has changed. kEventCodeITEMRENAMED Check to see if an item has been renamed. kEventCodeKEYSCHANGED Check to see if keyframes have changed. kEventCodePARMADDED Check to see if a parm has been added. kEeventCodePARMCHANGED Check to see if a parm has been changed. kEventCodePARMDELETED Check to see if a parm has been deleted. kEventCodeSETUPMODE Check to see if Poser has been placed in Setup Room mode.
23
METHODS
This section contains the list of custom PoserPython methods. Each method is listed in a separate table, and each table is laid out as follows: Method Name: The exact name of the method. Explanation: What the method does. Arguments: This is a list of possible arguments valid for the listed method. Syntax: Displays the methods syntax in the format Return, Method, Arguments, for example: <return value type> Method (<type of argument> argument 1, <type of argument> argument 2). Arguments enclosed in curly braces { } are optional and may default to a value if not specified by caller. Default values are shown following the equals sign. Example: Some method listings contain an example of how that method might be used.
NOTE: Please note that file paths differ between Mac and Windows operating systems. A Mac path might appear as MyHardDisk:SomeFolder:Poser:Runtime:Python: poserScripts:myscript.py, whereas a Windows path might look like C:\Some Folder\Poser\Runtime\Python\poserScripts\myscript.py. This is reflected in the different platform-specific versions of Python, and it is similarly reflected here. Please refer to one of the Python resources listed above for further information. Furthermore, PoserPython allows the user to refer to files relative to the Poser folder, for example: Runtime:Python:poserScripts: myscript.py and Runtime\Python\poser Scripts\ myscript.py, respectively.
GENERAL METHODS
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation AppLocation Query the file path location of the Poser application. none <StringType> AppLocation() CloseDocument Close the current Poser document. When set to a value other than zero, the argument causes the method to discard any changes. Discard changes = 0 by default. <NoneType> CloseDocument({<IntType> discardChanges = 0}) DefineMaterialWacroButton Attach a python script to one of 10 user defineable material wacro buttons. This method is related to Wacro Setup.
24

Arguments This method requires 3 arguments:
Index: Index specifies to which button the script will be assigned, from 1 to 10, with 1 being the top button. File Name: The file name of the script that the button will access.
Syntax Method Name Explanation Arguments
Label: How you wish to label the button. <NoneType> DefineWacroButton(<IntType> buttonIndex, <StringType> filePath, <StringType> label) DefineScriptButton Attach a python script to one of the 10 buttons on the Python Scripts palette. This method requires 3 arguments: Button Number: From 1 to 10, the button to which the script will be assigned, with 1 being the top button. File Path: The complete path to the desired script. Label: How you wish to label the button.
Syntax Example
<NoneType> DefineScriptButton(<IntType> buttonIndex, <StringType> filePath, <StringType> label) poser.DefineScriptButton (1, C:\Program Files\Curious Labs\Poser 4\Runtime\Python\test.py, Test Script) DialogDirChooser Implements a directory chooser callable from Posers Python interface. Specify the type of dialog you wish to use, the specific message text, and the directory that will be selected by default in the dialog. <DialogDirChooserType> DialogDirChooser(<DialogType> parentDialog, <StringType> message, <StringType> startDir) DialogFileChooser Implements a file chooser callable from Posers Python interface. Enter a Dialog Simple Code constant representing a File Open or File Save dialog. <DialogFileChooserType> DialogFileChooser(<IntType> type, <DialogType> parentDialog, <StringType> message, <StringType> startDir) DialogTextEntry Implements a simple (one-field) text entry dialog. Specify the type of dialog and the specific message you wish to use. <DialogTextEntry> DialogTextEntry(<DialogType> parentDialog, <StringType> message) ExecFile
Method Name Explanation Arguments Syntax
Method Name
25

Explanation Arguments Syntax Example Run a Python script using a Mac or Windows pathname. Enter the complete path of the script you wish to execute.
<NoneType> ExecFile(<StringType> fileName) poser.ExecFile (My Macintosh:Curious Labs:Poser 4:Runtime: Python:test.py) Language Query the applications language. The integer returned will match one of the language codes explained above. none <IntType> Language() NewDocument Open the default Poser document none <NoneType> NewDocument() NewGeometry Create an empty geometry object that is not attached to the scene. Use the actor.SetGeometry() method to attach geometry to an actor once it is built. none <GeomType> NewGeometry() OpenDocument Open an existing Poser document (.pz3 file). Takes a file path (absolute or relative to the Poser folder) as the argument. Enter either the complete or relative path to the Poser document you wish to open. <NoneType> OpenDocument(<StringType> filePath) poser.OpenDocument(My Macintosh:Runtime:Scenes: myscene.pz3) RevertDocument Revert the current document to the last saved state. none <NoneType> RevertDocument() SaveDocument Save an existing Poser document. Takes an optional file name as argument. Enter a valid path to save the file to that location/filename. If you do not specify an
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example
Method Name Explanation Arguments Syntax Method Name Explanation Arguments
26
argument, the file will be saved in its current path with its current name. Syntax Example <NoneType> SaveDocument({<StringType> filePath}) poser.SaveDocument(C:\My Documents\Poser Stuff\myscene2.pz3) Scene Return the current Poser scene as an object. none <SceneType> Scene() Version Return the version number for Poser. none <StringType> Version()
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
SCENE METHODS
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Actor Find a scene actor by its external name. This is the name seen in Poser GUI pull-down menus (such as Left Forearm). Enter the desired actors external name. <ActorType> Actor(<StringType> actorName) actor = scene.Actor(Left Forearm) ActorByInternalName Find a scene actor by its internal name. The argument string is the unique identifier for the object kept internally by Poser. Enter the actors internal name. <ActorType> ActorByInternalName(<StringType> internalName) actor = scene.ActorByInternalName(lRing2) Actors Get a list of the non-figure actor objects in the scene. Actors are items that populate the scene such as props, cameras, lights, or deformers. They can also be body-parts of a figure, although body-part actors will not be returned in this list. To get a list of actors belonging to a figure, use the Actors() method for a figure object. none <ActorType List> Actors() AnimSet
Arguments Syntax Method Name
27

Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Return the specified animation set. Enter a valid animation set name.
<AnimSetType> AnimSet(<StringType> AnimSetName) someAnimSet = scene.AnimSet(MyNewAnimationSet) AnimSets Return a list of all animation sets within the scene none <AnimSetType list> AnimSets() AntialiasNow Draw the current display with anti-aliasing enabled. none <NoneType> AntialiasNow() AtmosphereShaderTree Returns the ShaderTree for the atmosphere. none <ShaderTreeType> AtmosphereShaderTree() BackgroundColor Return the RGB color in the range 0.0 to 1.0 that is being used for the background display. none (<FloatType> R, <FloatType> G, <FloatType> B) BackgroundColor() BackgroundImage Returns the name of the current background image, if any. none <StringType> BackgroundImage() BackgroundMovie Returns the name of the current background movie, if any. none <StringType> BackgroundMovie() BackgroundShaderTree
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name
28

Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Returns the ShaderTree for the scenes background. none <ShaderTreeType> BackgroundShaderTree() Cameras
Return a list of scene cameras. Note that cameras are a specific kind of actor. none <ActorType List> Cameras() ClearEventCallback Clear the per-event callback set with SetEventCallback() None <NoneType> ClearEventCallback ClearSound Specifies that no sound file is to be associated with this Poser document. none <NoneType> ClearSound() ClearStartupScript Specify that no Python script is to be associated with the current Poser document and un-assign the currently associated startup script. none <NoneType> StartupScript() ClearWorldspaceCallback Clear the per-update callback to process scene elements after the entire scene has been processed to world space. none <NoneType> ClearWorldspaceCallback() ClothSimulator Returns the ClothSimulator with the specified index. Specify the index of the desired ClothSimulator. <ClothSimulatorType> ClothSimulator(<IntType> Index) ClothSimulatorByName Find a ClothSimulator object by its name.
29

Arguments Syntax Specify the name of the ClothSimulator you wish to locate.
<ClothSimulatorType> ClothSimulatorByName(<StringType> name) CopyToClipboard Copy the current display to the clipboard. none <NoneType> CopyToClipboard() CreateAnimSet Create a new animation set with the selected name. Note that if entering a name of an already existing animation set will cause an exception error. Enter your desired animation set name, ensuring there is not already an existing animation set with the same name. <AnimSetType> CreateAnimSet(<StringType> AnimSetName) newAnimSet = scene.CreateAnimSet(MyNewAnimationSet) CreateClothSimulator Create a new ClothSimulator object. Specify the name of the ClothSimulator object. <ClothSimulatorType> CreateClothSimulator(<StringType> name) CreateGeomFromGroup Generate a new geometry object from a polygon group. Enter a valid group name from which the polygons will be obtained. <GeomType> CreateGeomFromGroup(<ActorType> actor, <StringType> groupName) geom = scene.CreateGeomFromGroup(Abdomen) CreateLight Create a new spotlight in the scene. none <NoneType> CreateLight() CreateMagnet Create a magnet on the current actor. none <NoneType> CreateMagnet()
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
30
Method Name Explanation Arguments
CreatePropFromGeom Create a new scene prop from a geometry. This method requires 2 arguments: Geometry: This object can be obtained from existing actor geometry, or it can be built from scratch starting with an empty geometry object. (See poser.NewGeometry()). Prop Name: A string naming the new prop.
Syntax Example
<ActorType> CreatePropFromGeom(<GeomType> geometry, <StringType> propName) newProp = scene.CreatePropFromGeom(someActor.Geometry(), ImaProp) CreateWave Create a wave deformer on the current actor. none <NoneType> CreateWave() CurrentActor Get the currently selected actor. none <ActorType> CurrentActor() CurrentCamera Get the current camera. Note that cameras are a specific kind of actor. none <ActorType> CurrentCamera() CurrentFigure Get the currently selected figure. none <FigureType> CurrentFigure() CurrentFireFlyOptions Returns the current FireFly options. none <FireFlyOptionsType> CurrentFireFlyOptions() CurrentLight
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name
31

Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation
Get the current light. Note that lights are a specific kind of actor. none <ActorType> CurrentLight() CurrentMaterial Returns the currently selected material. Returns None if no material is selected. none <MaterialType> CurrentMaterial() CurrentRenderEngine Get the current render engine. none <IntType> CurrentRenderEngine() DeleteAnimSet Delete the specified animation set. Enter your desired animation set name. <NoneType> DeleteAnimSet(<StringType> AnimSetName) scene.DeleteAnimSet(MyNewAnimationSet) DeleteCurrentFigure Delete the currently selected figure. none <NoneType> DeleteCurrentFigure() DeleteCurrentProp Delete the currently selected prop. none <NoneType> DeleteCurrentProp() DisplayStyle Get the documents interactive display style. Typical return values correspond to poser member variable constants (such as poser.kDisplayCodeWIREFRAME). none <IntType> DisplayStyle() Draw Redraw modified objects.
32

Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax none <NoneType> Draw() DrawAll Redraw everything in the scene. none <NoneType> DrawAll() Figure
Get a figure, given its name. The argument is the external name in the Poser GUI pulldown menus (such as Figure 1). Enter the figures name. <FigureType> Figure(<StringType> figureName) fig = scene.Figure(Figure 1) Figures Get a list of the figure objects in the scene. Figures are bodies composed of actors in a hierarchy. none <FigureType list> Figures() FireFlyOptions Returns the FireFly options with the specified index. Specify the index of the desired FireFly options. <FireFlyOptionsType> FireFlyOptions(<IntType> index) FireFlyOptionsByName Finds FireFly options using a specified name. Specify the name of the desired FireFly options. <FireFlyOptionsType> FireFlyOptionsByName(<StringType> name) ForegroundColor Return the foreground RGB color in the range 0.0 to 1.0 none (<FloatType> R, <FloatType> G, <FloatType> B) ForegroundColor() Frame
Method Name
33

Explanation
Return the current frame number. All frame numbers in PoserPython are relative to a starting frame of 0. For this reason, a frame number in Python is 1 less than the equivalent frame as referenced from the Poser GUI. none <IntType> Frame() FramesPerSecond Return the current frame rate. none <IntType> FramesPerSecond() GeomFileName Returns the filename of the geometry being used by the current actor, if any. none <StringType> actor.GeomFileName() GroundColor Return the ground RGB color in the range 0.0 to 1.0. none (<FloatType> R, <FloatType> G, <FloatType> B) GroundColor() GroundShadows Get status of ground shadow display. none <NoneType> GroundShadows() ImExporter Get the importer/exporter object to access importing and exporting of non-Poser 3D file formats. none <ImExporterType> ImExporter() Lights Return a list of scene lights. Note that lights are a specific kind of actor. none <ActorType List> Lights() LoadLibraryCamera
Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name
34

Explanation
Load camera positions from a camera library file (.cm2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete path and file name. <NoneType> LoadLibraryCamera(<StringType> filePath) scene.LoadLibraryCamera(Runtime\Libraries\ MyCamera.cm2) LoadLibraryFace Load face from a face library file (.fc2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete path and file name. <NoneType> LoadLibraryFace(<StringType> filePath) scene.LoadLibraryFace(\Runtime\Libraries\MyFace. fc2) LoadLibraryFigure Load a figure from a character library file (.cr2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete path and file name. <NoneType> LoadLibraryFigure(<StringType> filePath) scene.LoadLibraryFigure(\Runtime\Libraries\ MyFigure.cr2) LoadLibraryHair Load figure hair from a hair library file (.hr2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete path and file name. <NoneType> LoadLibraryHair(<StringType> filePath) scene.LoadLibraryHair(\Runtime\Libraries\MyHair.hr2) LoadLibraryHand Load hand pose from a hand library file (.hd2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Filename: Enter the complete path and file name. Left Hand: Entering 0 returns a left hand, any other value returns a right.
Arguments Syntax Example Method Name Explanation
Arguments Syntax Example
Method Name Explanation
Arguments
Syntax Example
<NoneType> LoadLibraryHand(<StringType> filePath, {<IntType> leftHand = 0}) scene.LoadLibraryHand(\Runtime\Libraries\MyHands. hd2,
35

1) Method Name Explanation LoadLibraryLight
Load light positions from a light library file (.lt2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete path and file name. <NoneType> LoadLibraryLight(<StringType> filePath) scene.LoadLibraryLight(\Runtime\Libraries\ MyLight.lt2) LoadLibraryPose Load pose from a pose library file (.pz2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete path and file name. <NoneType> LoadLibraryPose(<StringType> filePath) scene.LoadLibraryPose(\Runtime\Libraries\MyPose. pz2) LoadLibraryProp Load a prop from a prop library file (.pp2). Filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete path and file name. <NoneType> LoadLibraryProp(<StringType> filePath) scene.LoadLibraryProp(\Runtime\Libraries\MyProp. pp2) MovieMaker Get a MovieMaker object to access animation specifics. All methods needed to output animated movies can be accessed from the returned object. none <MovieMakerType> MovieMaker() NextKeyFrame Returns the frame number of the next key frame for the current actor. none <IntType> NextKeyFrame() NextKeyFrameAll Returns the frame number of the next key frame in the current scene. none
Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments
36

Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax <IntType> NextKeyFrameAll() NumBodyParts Return the number of body parts in the scene. none <IntType> NumBodyParts() NumBumpMaps Return the number of bump-maps in the scene. none <IntType> NumBumpMaps() NumCameras Return the number of cameras in the scene. none <IntType> NumCameras() NumClothSimulators Returns the number of ClothSimulators in the scene. none <IntType> NumClothSimulators() NumFigures Return the number of figures in the scene. none <IntType> NumFigures() NumFrames Return the number of frames of animation. none <IntType> NumFrames() NumGeometries
Return the number of geometries in the scene (equal to the number of props [numProps] + plus the number of body parts [numBodyParts]). none <IntType> NumGeometries()
37

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation NumImageMaps Return the number of image-maps in the scene. none <IntType> NumImageMaps() NumLights Return the number of lights in the scene. none <IntType> NumLights() NumProps Return the number of props in the scene. none <IntType> NumProps() OutputRange
Return a tuple containing the frame range to be used for image and library output. All frame numbers in PoserPython are relative to a starting frame of 0. For this reason, a frame number in Python is 1 less than the equivalent frame as referenced from the Poser GUI. none (<IntType> x, <IntType> y) OutputRange() OutputRes Return a tuple containing the output image. The resolution consists of a horizontal and a vertical number of pixels. none (<IntType> x, <IntType> y) OutputRes() PrevKeyFrame Return the frame number of the previous key frame for the current actor. none <IntType> PrevKeyFrame() PrevKeyFrameAll Return the frame number of the previous key frame in the scene. none <IntType> PrevKeyFrameAll()
38

Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation ProcessSomeEvents Process the specified number of Poser events. Enter the number of events to process (integer value).
<NoneType> ProcessSomeEvents({<IntType> numEvents = <argument>) ProcessSomeEvents(numEvents = 1) Render Render to the current view. none <NoneType> Render() RenderAntiAliased Query renderers use of anti-aliasing. A return value of 1 indicates that the option is on, while a value of 0 indicates that it is off. none <IntType> RenderAntiAliased() RenderBumpMaps Query the renderers use of bump maps. A return value of 1 indicates that the option is on, while a value of 0 indicates that it is off. none <IntType> RenderBumpMaps() RenderCastShadows Query rendering of shadows. A return value of 1 indicates that the option is on, while a value of 0 indicates that it is off. none <NoneType> RenderCastShadows() RenderOnBGColor Query render-on-background-color option. A return value of 1 indicates that the option is on, while a value of 0 indicates that it is off. none <IntType> RenderOnBGColor() RenderOnBGPict Query render-on-background-picture option. A return value of 1 indicates that the option is on, while a value of 0 indicates that it is off.
39

Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax none <IntType> RenderOnBGPict() RenderOnBlack
Query render-on-black option. A return value of 1 indicates that the option is on, while a value of 0 indicates that it is off. none <IntType> RenderOnBlack() RenderTextureMaps Query the renderers use of texture maps. A return value of 1 indicates that the option is on, while a value of 0 indicates that it is off. none <IntType> RenderTextureaps() RenderToNewWindow Query render-to-new-window option. A return value of 1 indicates that the option is on, while a value of 0 indicates that it is off. none <IntType> RenderToNewWindow()
40
SaveImage Write the current view to an image file with the specified format. The output filename should be a path (either absolute or relative to the Poser folder). Format : Enter the three-character file suffix for your desired image format. Supported formats are BMP, JPG, PCT, PNG, and TIF. Filename: Enter the complete path and filename.
Syntax Example
<NoneType> SaveImage(<String Type> formatSuffix, <StringType> filePath) scene.SaveImage (bmp, C:\My Documents\My Pictures\mypic.bmp) SaveLibraryCamera Save the current cameras to a camera library file (.cm2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Filename: Enter the complete path and filename. Multiple frames: Enter 0 for a single frame, any other value for multiple frames. Start Frame: Enter the starting frame of the current animation to save. End Frame: Enter the ending frame of the current animation to save.
Arguments
Syntax
<NoneType> SaveLibraryCamera(<StringType> filePath, {<IntType> multiFrame, <IntType> startFrame, <IntType> endFrame}) scene.SaveLibraryCamera(Runtime\Libraries\ MyCamera.cm2, 1,25,68) SaveLibraryFace Save the current face as a face library file (.fc2). The Filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Filename: Enter the complete path and filename. Multiple frames: Enter 0 for a single frame, any other value for multiple frames. Start Frame: Enter the starting frame of the current animation to save. End Frame: Enter the ending frame of the current animation to save.
Example
Arguments
Syntax
<NoneType> SaveLibraryFace(<StringType> filePath, {<IntType> multiFrame = 0, <IntType> startFrame = 0, <IntType> endFrame = 0}) scene.SaveLibraryFace(\Runtime\Libraries\MyFace. fc2, 1,25,68)
Example
41
SaveLibraryFigure Save current figure to a character library file (.cr2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete file name and path. <NoneType> SaveLibraryFigure(<StringType> filePath) scene.SaveLibraryFigure(Runtime:Libraries: MyFigure.cr2) SaveLibraryHair Save figure hair to a hair library file (.hr2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete file name and path. <NoneType> SaveLibraryHair(<StringType> filePath) scene.SaveLibraryHair(Runtime:Libraries:MyHair. hr2) SaveLibraryHand Save hand pose to a hand library file (.hd2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete file name and path. <NoneType> SaveLibraryHand(<StringType> filePath, {<IntType> multiFrame = 0, <IntType> startFrame = 0, <IntType> endFrame = 0}) scene.SaveLibraryHand(Runtime:Libraries:MyHair. hd2) SaveLibraryLight Save current lights to a light library file (.lt2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete file name and path. <NoneType> SaveLibraryLight(<StringType> filePath, {<IntType> multiFrame, <IntType> startFrame, <IntType> endFrame}) scene.SaveLibraryLight(Runtime:Libraries:MyLight. lt2)
Arguments Syntax
Example Method Name Explanation
Arguments Syntax
Example
42
SaveLibraryPose Save current pose as a pose library file (.pz2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete file name and path. <NoneType> SaveLibraryPose(<StringType> filePath, {<IntType> includeMorphTargets, <IntType> multiFrame, <IntType> startFrame, <IntType> endFrame}) scene.SaveLibraryPose(Runtime:Libraries:MyPose. pz2) SaveLibraryProp Save current prop as a prop library file (.pp2). The filename should be a path (either absolute or relative to the Poser folder). Libraries are typically stored under Poser/Runtime/libraries. Enter the complete file name and path. <NoneType> SaveLibraryProp(<StringType> filePath) scene.SaveLibraryProp(Runtime:Libraries:MyProp. pp2) SelectActor Set the current actor (i.e. Select an actor). Enter the name of actor to select. <NoneType> SelectActor(<ActorType> actor) scene.SelectActor(Left Forearm) SelectFigure Set the current figure (i.e. Select a figure). Enter the figure you wish to select. <NoneType> SelectFigure(<FigureType> figure) scene.SelectFigure(Figure 1) SetBackgroundColor Set the background RGB color using values in the range 0.0 to 1.0) R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0.
Arguments Syntax
Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments
Syntax Example
<NoneType> SetBackgroundColor(<FloatType> R, <FloatType> G, <FloatType> B) scene.SetBackgroundColor(0.4,0.5,0.6)
43

Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example SetBackgroundImage
Set the background image to the specified file. The filename should be a path (either absolute or relative to the Poser folder). Enter the complete file name and path. <NoneType> SetBackgroundImage(<StringType> filePath) scene.SetBackgroundImage(D:\Images\MyImage.jpg) SetBackgroundMovie Set background movie to show behind scene. The filename should be a path (either absolute or relative to the Poser folder). Enter the complete file name and path. <NoneType> SetBackgroundMovie(<StringType> movieName) scene.SetBackgroundImage(D:\Movies\MyMovie.avi) SetCurrentCamera Set the current camera. Note that cameras are a specific kind of actor. Enter a valid camera name (Left, Main, Aux, etc.) <NoneType> SetCurrentCamera(<ActorType> camera) SetCurrentCamera(leftCamera) SetCurrentLight Set the current light. Note that lights are a specific kind of actor. Enter a valid Poser light actor. <NoneType> SetCurrentLight(<ActorType> light) scene.SetCurrentLight(spotLight) SetCurrentRenderEngine Set the current render engine. Specify the desired render engine. <NoneType> SetCurrentRenderEngine(<IntType> Engine) SetDisplayStyle Set interactive display style of the document. Typical values are constants defined as poser member variables (such as poser.kDisplayCodeWIREFRAME). Enter a valid display code. <NoneType> SetDisplayStyle(<IntType> displayCode) scene.SetDisplayStyle(poser.kDisplayCodeSMOOTH LINED)
44
SetEventCallback Set a per-event callback function that will be called for every Poser event. The callback function passed in should take two arguments: A scene object and an eventCode. Bit wise, the eventCode can be compared to known eventCode constants to detect the type of events occurring. Enter a valid scene object and a valid eventCode. <NoneType> SetEventCallback (<FunctionType> newCD, {<Object> cbArgs}) Click the Sample Callbacks button in the Python palette to see an example using this method. SetForegroundColor Set the foreground RGB color using values in the range 0.0 to 1.0) R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0.
Syntax Example Method Name Explanation
<NoneType> SetForegroundColor(<FloatType> R, <FloatType> G, <FloatType> B) scene.SetForegroundColor(0.4,0.5,0.6) SetFrame Set the current frame number. All frame numbers in PoserPython are relative to a starting frame of 0. For this reason, a frame number in Python is 1 less than the equivalent frame as referenced from the Poser GUI. Enter a valid frame number. <NoneType> SetFrame(<IntType> frame) scene.SetFrame(23) SetGroundColor Set the ground RGB color using values in the range 0.0 to 1.0) R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0.
Arguments Syntax Example Method Name Explanation Arguments
Syntax Example
<NoneType> SetGroundColor(<FloatType> R, <FloatType> G, <FloatType> B) scene.SetGroundColor(0.4,0.5,0.6)
45
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation
SetGroundShadows Toggle display of ground shadows. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. Enter 0 to disable ground shadows, or 1 to enable them. <NoneType> SetGroundShadows({<IntType> on = 1}) scene.SetGroundShadows(1) SetMeAsStartupScript Specify the current script as the Python script associated with the current Poser doc and executed on startup when the document is re-opened. none <NoneType> SetMeAsStartupScript() SetOutputRange Specify the output frame range to be used for image and library output (for images). All frame numbers in PoserPython are relative to a starting frame of 0. For this reason, a frame number in Python is 1 less than the equivalent frame as referenced from the Poser GUI. Start Frame (X): Enter a numeric value that is less than or equal to the end frame value. End Frame (Y): Enter a numeric value that is greater than or equal to the start frame value.
Arguments
Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example
<NoneType> SetOutputRange(<IntType> x, <IntType> y) scene.SetOutputRange(25,67) SetOutputRes Set output resolution (for images). Resolution consists of a horizontal and a vertical number of pixels. Enter a dimension in pixels using the format x,y. <NoneType> SetOutputRes(<IntType> x, <IntType> y) scene.SetOutput Res(640,480) SetRenderAntiAliased Toggle renderer anti-aliasing. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. Enter 1 to enable anti-aliasing, or 0 to disable it. <NoneType> SetRenderAntiAliased({<IntType> on = 1}) scene.SetRenderAntiAliased(0)
46

Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation SetRenderBumpMaps
Toggle renderer use of bump maps. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. Enter 1 to enable bump map use, or 0 to disable it. <NoneType> SetRenderBumpMaps({<IntType> on = 1}) scene.SetRenderBumpMaps(1) SetRenderCastShadows Toggle rendering of shadows. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. Enter 1 to enable cast shadow rendering, or 0 to disable it. <NoneType> SetRenderCastShadows({<IntType> on = 1}) scene.SetRenderCastShadows(1) SetRenderOnBGColor Set the renderer to render over background color. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. Enter 1 to enable rendering over the background color, or 0 to disable it. <NoneType> SetRenderOnBGColor({<IntType> on = 1}) scene.SetRenderOnBGColor(1) SetRenderOnBGPict Set the renderer to render over background picture. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. <NoneType> RenderOnBGPict({<IntType> on = 1}) Enter 1 to enable rendering over the current background picture, or 0 to disable it. scene.RenderOnBGPicture(0) SetRenderOnBlack Set the renderer to render over black. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. Enter 1 to enable rendering against a black background, or 0 to disable it. <NoneType> SetRenderOnBlack({<IntType> on = 1}) scene.SetRenderOnBlack(1)
Arguments Syntax Example Method Name Explanation Arguments Syntax Example
47
Method Name Explanation Arguments Syntax Example
SetRenderTextureMaps Toggle the renderers use of texture maps. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. Enter 1 to enable bump map use, or 0 to disable it. <NoneType> SetRenderTextureMaps({<IntType> on = 1}) scene.SetRenderTextureMaps(1)
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments
SetRenderToNewWindow Toggle render-to-new-window option. The default argument of 1 specifies that the option should be turned on. To turn it off, call the function with an argument of 0. Enter 1 to render to a new window, or 0 to disable it. <NoneType> SetRenderToNewWindow({<IntType> on = 1}) scene.SetRenderToNewWindow(0) SetShadowColor Set the shadow RGB color using values in the range 0.0 to 1.0) R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0.
Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example
<NoneType> SetShadowColor(<FloatType> R, <FloatType> G, <FloatType> B) scene.SetShadowColor(1.0,1.0,0.3) SetSound Specify the sound file to be associated with this Poser document. Sound files play during animation. Enter the complete path and file name. <NoneType> SetSound(<StringType> filePath) scene.SetSound(C:\My Music\Sound1.wav) SetSoundRange Specify the frame range over which the sound should be played during animation. Enter valid starting and ending frames for the sound. <NoneType> SetSoundRange(<IntType> startFrame, <IntType> endFrame) scene.SetSoundRange(5,12)
48

Method Name Explanation SetStartupScript
Specify the Python script to associate with the current Poser document and executed on startup when the file is re-opened. The filename should be a path (either absolute or relative to the Poser folder). Enter the complete path and file name. <NoneType> SetStartupScript(<StringType> filePath) scene.SetStartupScript(\Runtime\Python\script.py) SetWorldspaceCallback Set a per-update callback to process scene elements after the entire scene has been processed to world space. The callback function should take the scene as an argument and make any scene changes desired. The changes will occur after all objects have placed themselves in world space, but before the final drawing takes place. <NoneType> SetWorldspaceCallback(<FunctionType> newCB, {<Object> cbArgs}) (See sample scripts) ShadowColor Return the shadow RGB color using values in the range 0.0 to 1.0) R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0.
Syntax Example Method Name Explanation Arguments
Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
(<FloatType> R, <FloatType> G, <FloatType> B) ShadowColor() scene.ShadowColor(1.0,1.0,0.3) Sound Return the name of the sound file associated with the current Poser document that plays during animations. none <StringType> Sound() SoundRange Return the frame range over which the sound is played during animation. Returns a tuple containing the start frame and the end frame. none (<IntType>, <IntType>) SoundRange()
49
StartupScript Return the Python script to be associated with the current Poser document and executed on startup when the document is reopened. The returned filename is a path (either absolute or relative to the Poser folder). none <StringType> StartupScript() UpdateBGPreview Updates the previews background. Call this function after you modify the background shader. none <NoneType> UpdateBGPreview() WacroMaterials Returns a list of materials on which a wacro is to be executed. This method is intended for use inside wacros; they should iterate over this list. none <MaterialType list> GetWacroMaterials()
Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
MOVIEMAKER METHODS
Method Name Explanation Arguments Syntax FlashAutoPlay Query the Flash auto-play option. Returns 1 if the option is enabled, 0 if disabled. none <IntType> FlashAutoPlay()
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation
FlashDrawInnerLines Query the Draw Inner Lines option for Flash export. A return value of 1 means that the option is on, while a 0 means that the option is off. none <IntType> FlashDrawInnerLines() FlashDrawOuterLines Query the Draw Outer Lines option for Flash export. A return value of 1 means that the option is on, while a 0 means that the option is off. none <IntType> FlashDrawInnerLines() FlashLineWidth Get the width of drawn lines for Flash export. Note that both inner and outer lines use
50

the same line width. Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation none <FloatType> FlashLineWidth() FlashNumColors Get the number of colors to be used for Flash export. none <IntType> FlashNumColors() FlashOverlapColors
Query the Overlapping Colors option for Flash export. A return value of 1 means that the option is on, while a 0 means that the option is off. none <IntType> FlashOverlapColors() FlashQuantizeAll Query the Quantize All Frames option for exporting Flash. A return value of 1 means that the option is on, while a 0 means that the option is off. Note that this return value will always be the negation of moviemaker.FlashQuantizeOne. none <IntType> FlashQuantizeAll() FlashQuantizeFrame Get the frame to be quantized when exporting Flash with the quantize-one-frame option on. none <IntType> FlashQuantizeFrame() FlashQuantizeOne Query the Quantize Specified Frame option for exporting Flash. A return value of 1 means that the option is on, while a 0 means that the option is off. Note that this return value will always be the negation of moviemaker.FlashQuantizeAll. none <IntType> FlashQuantizeOne() MakeFlash Write the animation to a Flash file (*.swf). Enter the complete file name and path for the output file. <NoneType> MakeMovieFlash(<StringType> filePath)
Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation
Arguments Syntax Method Name Explanation Arguments Syntax
51

mm.MakeFlash(C:\MyDocuments\myflashmovie.swf) OutputEndFrame Return the last frame to be used in making the movie. All frame numbers in PoserPython are relative to a starting frame of 0. For this reason, a frame number in Python is 1 less than the equivalent frame as referenced from the Poser GUI. none <IntType> OutputEndFrame() OutputRes Return a tuple containing output resolution (for movies). none (<IntType> x, <IntType> y) OutputRes OutputStartFrame Return the first frame to be used in making the movie. All frame numbers in PoserPython are relative to a starting frame of 0. For this reason, a frame number in Python is 1 less than the equivalent frame as referenced from the Poser GUI. none <IntType> OutputStartFrame() SetFlashAutoPlay Set the Auto Play option for Flash Export. Enter 1 to enable the option, or 0 to disable it. <NoneType> SetFlashAutoPlay({<IntType> on}) mm.SetFlashAutoPlay(1) SetFlashDrawInnerLines Toggle drawing of inner lines for Flash export. The default argument of 0 specifies that the overlapping-colors option is off. To turn it on, call the function with an argument of 1. Enter 1 to enable drawing inner lines, or 0 to disable. <NoneType> SetFlashDrawInnerLines({<IntType> on = 0}) mm.SetFlashDrawInnerLines(1) SetFlashDrawOuterLines Toggle drawing of outer lines for Flash export. The default argument of 1 specifies that the overlapping-colors option is on. To turn it off, call the function with an argument of 0. Enter 1 to enable drawing outer lines, or 0 to disable.
Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation
Arguments
52

Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation
<NoneType> SetFlashDrawOuterLines({<IntType> on = 1}) mm.SetFlashDrawOuterLines(1) SetFlashLineWidth Set the width of drawn lines for Flash export. Note that both inner and outer lines use the same line width. Enter any valid floating-point number. <NoneType> SetFlashLineWidth({<FloatType> width = 1.0}) mm.SetFlashLineWidth(2.43) SetFlashNumColors Set the number of colors to be used for Flash export. Enter the number of colors to use. <NoneType> SetFlashNumColors({<IntType> numColors = 4}) mm.SetFlashNumColors(6) SetFlashOverlapColors Toggle overlapping colors for Flash export. The default argument of 1 specifies that the overlapping-colors option is on. To turn it off, call the function with an argument of 0. Enter 1 to enable overlapping colors, or 0 to disable. <NoneType> SetFlashOverlapColors({<IntType> on = 1}) mm.SetFlashOverlapColors(1) SetFlashQuantizeAll Quantize all frames when exporting flash. none <NoneType> SetFlashQuantizeAll() SetFlashQuantizeFrame Specify the frame to be quantized when exporting Flash with the quantize-one-frame option on. Enter the number of the selected frame. <NoneType> SetFlashQuantizeFrame({<IntType> frame}) mm.SetFlashQuantizeFrame(4)
Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example
53
Method Name Explanation Arguments Syntax Example Method Name Explanation
SetFlashQuantizeOne Quantize a specified frame when exporting Flash. If the frame argument is supplied, the quantize frame will be set to it. Otherwise, the existing value will be used. Enter the desired frame number. <NoneType> SetFlashQuantizeOne({<IntType> frame}) mm.SetFlashQuantizeOne(12) SetOutputEndFrame Set the last frame to be used in making the movie. All frame numbers in PoserPython are relative to a starting frame of 0. For this reason, a frame number in Python is 1 less than the equivalent frame as referenced from the Poser GUI. Enter the number of the ending frame. <NoneType> SetOutputEndFrame(<IntType> frame) mm.SetOutputEndFrame(60) SetOutputRes Set output resolution (for movies). Enter the X and Y resolution in pixels. <NoneType> SetOutputRes(<IntType> x, <IntType> y) mm.SetOutputRes(640,640) SetOutputStartFrame Set the first frame to be used in making the movie. All frame numbers in PoserPython are relative to a starting frame of 0. For this reason, a frame number in Python is 1 less than the equivalent frame as referenced from the Poser GUI. Enter the number of the starting frame. <NoneType> SetOutputStartFrame(<IntType> frame) mm.SetOutputStartFrame(1)
Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation
IMPORTER/EXPORTER METHODS
Method Name Explanation Export Export models using plug-ins. The file suffix argument is the extension typically following files of the type to be exported, such as dxf. The filePath string (which can be an absolute path, or a path relative to the Poser folder) specifies the file to be exported. The default options-dictionary can be acquired by a call to the imexporter.ExportOptions() method with the same fileSuffix as an argument. It can then be modified and passed back as an argument to this method. If this argument is omitted, the default options will be used. The optional scene hierarchy callback function allows for specification of object inclusion in the export process. The function should take an actor object and return 1 if the actor is to be included and 0 if the actor is to be excluded. The function is called back for all scene
54

actors. If omitted, all visible objects will be exported. Arguments
Syntax
File Suffix: Viewpoint: mtx Biovision (BVH Motion): bvh 3D Studio Max: 3ds QuickDraw 3DMF: 3df AutoCAD: dxf Detailer Text: vtx Wavefront OBJ: OBJ Plug-in Names: Poser needs plug-ins to support some export formats. If a valid export format does not appear here, that format is supported directly within the Poser application itself. The plug-in name can typically be set to None. However, if two plug-ins exist which export files ending in the same suffix, then you can use the plug-in name to distinguish between the two. Viewpoint: File Format MetaStream 3D Studio Max: File Format 3D Studio QuickDraw 3DMF: File Format 3DMF AutoCAD: File Format DXF Wavefront OBJ: File Format Wavefront File Path: Enter a valid path and filename. The path can be either the complete path or relative to the Poser folder. Option Dictionary: Enter any non-standard options (optional). If not supplied, the default options will apply. Function: Call a function if desired (optional). If not supplied, the default items will be exported. <NoneType> Export(<StringType> fileSuffix, <StringType> pluginName, <StringType> filePath, {<DictType> options, <FunctionType> sceneSelectionCallback}) Imex.Export(DXF, File Format DXF, C:\My Documents\Test.dxf) ExportOptions Get a dictionary of options for the specified exporter. The file suffix argument is the extension typically following files of the type to be exported, such as dxf. The actual plug-in name may be given (e.g. File Format HAnim) to specify which plugin to choose if there are several plug-ins that export the same file type. If only one plug-in exists that exports files with the given extension, then this argument may be None. Enter a valid export file suffix and plug-in name. <DictType> ExportOptions(<StringType> fileSuffix, <StringType> pluginName) imex.ExportOptions(obj, None) ExportOptionString Get an export option string for the specified file suffix and plugin name. The enumeration value is a key from the export options dictionary. Enter a valid export file suffix and plug-in name. <StringType> ExportOptionString(<StringType> fileSuffix, <StringType> pluginName, <IntType> enumValue)
Example
Arguments Syntax Example Method Name Explanation Arguments Syntax
55

Example imex.ExportOptionString("obj", None, poser.kExOptCodeMULTIFRAME) Import
Import models using plug-ins. The file suffix argument is the extension typically following files of the type to be exported, such as dxf. The filePath string (which can be an absolute path, or a path relative to the Poser folder) specifies the file to be imported. The default options-dictionary can be acquired by a call to the imexporter.ImportOptions() method with the same fileSuffix as an argument. It can then be modified and passed back to as an argument to this method. If this argument is omitted, the default options will be used. File Suffix: Viewpoint: mtx Biovision (BVH Motion): bvh 3D Studio Max: 3ds QuickDraw 3DMF: 3df AutoCAD: dxf Detailer Text: vtx Wavefront OBJ: OBJ File Path: Enter a valid path and filename. The path can be either the complete path or relative to the Poser folder. Option Dictionary: Enter any non-standard options. This is an optional argument. Default options used otherwise. <NoneType> Import(<StringType> fileSuffix, <StringType> filePath, {<DictType> options}) Import(DXF, C:\My Documents\test.dxf) ImportOptions Get a dictionary of options for the specified importer. The file suffix argument is the extension typically following files of the type to be exported, such as dxf. The actual plug-in name may be given (e.g. File Format HAnim) to specify which plugin to choose if there are several plug-ins that import the same file type. If only one plug-in exists that imports files with the given extension, then this argument may be None. Enter a valid import file suffix and plug-in name. <DictType> ImportOption(<StringType> fileSuffix, <StringType> pluginName) imex.ImportOptions(OBJ, none) ImportOptionString Get an import option string for the specified file suffix and plug-in name. The enumeration value is a key from the import options dictionary. Enter a valid import file suffix and plug-in name. <StringType> ImportOptionString(<StringType> fileSuffix, <StringType> pluginName, <IntType> enumValue) imex.ImportOptionString("OBJ", None, poser.kImOptCodePERCENTFIGSIZE)
Arguments
Arguments Syntax Example Method Name Explanation Arguments Syntax Example
56
ANIMATION SET METHODS

Method Name Explanation Arguments AddAttribute Adds a new attribute to the current animation set. Syntax Example Method Name Explanation Arguments Attribute Name: Enter the name of the attribute you wish to add. Value: Enter the desired value of the attribute.
<NoneType> AddAttribute(<StringType> name, <StringType> value) animset.AddAttribute(MyAttribute,1) AddObjectRange Add an object range to the animation set. The entity provided must be a figure, actor, or parameter. Object: Enter the name of a valid figure, actor, or parameter. Start Frame: Enter the number of the starting frame you wish to include (Python frames begin with 0). This number should be less than the end frame number. End Frame: Enter the number of the last frame you wish to include (Python frames begin with 0). This number should be greater than the start frame number.
Syntax
<NoneType> AddObjectRange (<FigureType, Actor Type, or ParmType>, sceneEntity, <IntType> StartFrame, <IntType> EndFrame) animset.AddObjectRange(someActor,5,20) Attributes Get a list of all attributes in the current animation set. Attributes are tuples consisting of the name of animation set and the corresponding value strong. none <TupleType list> Attributes() ObjectRange Get the object range for the specified animation set. none (<IntType> startFrame, <IntType> endFrame) ObjectRange() RemoveAttribute Remove an existing attribute from the current animation set. Attribute Name: Enter the name of the attribute you wish to add. Value: Enter the desired value of the attribute.
Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments
Syntax
<NoneType> RemoveAttribute(<StringType> name, {<StringType> value})
57

Example Method Name Explanation Arguments
animset.RemoveAttribute(MyAttribute, 1) RemoveObjectRange Remove an existing object range from the current animation set. Object: Enter the name of a valid figure, actor, or parameter. Start Frame: Enter the number of the starting frame you wish to include (Python frames begin with 0). This number should be less than the end frame number. End Frame: Enter the number of the last frame you wish to include (Python frames begin with 0). This number should be greater than the start frame number.
Syntax
<NoneType> RemoveObjectRange (<FigureType, ActorType, or ParmType>, sceneEntity, <IntType> StartFrame, <IntType> EndFrame) animset.RemoveObjectRange(someActor,5,20)
Example
ACTOR METHODS
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax AddKeyFrame Add a key frame for this parameter at the specified frame. If no frame is specified, a keyframe will be added at the current frame. Enter a valid frame number. <NoneType> AddKeyFrame({<IntType> frame}) AddKeyFrame(81) AlignmentRotationXYZ Get a tuple comprising the ordered rotation alignment for this actor. (order is X, Y, Z) none (<FloatType>, <FloatType>, <FloatType>) AlignmentRotationXYZ() AmbientOcclusion Query whether this light (if this actor is an image light) is using ambient occlusion. none <IntType> AmbientOcclusion() AmbientOcclusionBias Get the ambient occlusion bias of this light (if this actor is an image light). none <FloatType> AmbientOcclusionBias() AmbientOcclusionDistance
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name
58

Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments
Get the ambient occlusion maximum distance of this light (if this actor is an image light). none <FloatType> AmbientOcclusionDistance() AmbientOcclusionStrength Get the ambient occlusion strength of this light (if this actor is an image light). none <FloatType> AmbientOcclusionStrength() AtmosphereStrength Get the atmosphere strength of this light (if this actor is a light). none <FloatType> AtmosphereStrength() BackfaceCull Query the actor's backface culling flag. none <IntType> BackfaceCull() Base If the actor is a deformer, this method returns its base actor. none <ActorType> ActorBase() Bends Query whether or not the actor's bend flag is set. none <IntType> Bends() CastShadows Query whether this actor casts shadows. none <IntType> CastShadows() Children Get a list of the actors that are the children of the actor given. none
59

Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation <ActorType List> Children() ClearLocalTransformCallback Clear the local transform callback. none
<NoneType> ClearLocalTransformCallback() ClearVertexCallback Clear the vertex callback. none <NoneType> ClearVertexCallback() CreateHairGroup Create a new hair group. Specify the name of the hair group you wish to create. <HairType> CreateHairGroup(<StringType> name) CreateValueParameter Create a value parameter on the universe actor. This type of parameter is not linked to Poser elements such as figures, props, etc. Rather, it can be used to add user interface control to your Python scripts. Enter a name for the new parameter. <ParmType> CreateValueParameter(<StringType> valueParmName) parm = actor.CreateValueParameter(MyNewParameter) Delete Delete the actor from the scene if possible. Note that you cannot delete a body part from a figure. none <NoneType> Delete() DeleteKeyFrame Delete a key frame for this actor at the specified frame. If no frame is specified, a keyframe will be deleted at the current frame. Enter a valid frame number. <NoneType> DeleteKeyFrame({<IntType> frame}) parm.DeleteKeyFrame(30)
Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example
60

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation DisplacementBounds Get the actor's displacement bounds. none <FloatType> DisplacementBounds() DisplayStyle
Get the interactive display style for this actor. Typical return values correspond to poser member variable constants (such as poser.kDisplayCodeWIREFRAME). Enter a valid display code. <NoneType> SetDisplayStyle(<IntType> displayCode) actor.SetDisplayStyle(poser.kDisplayCode SMOOTHSHADED) DropToFloor Drop the actor downward (along the Y axis) until it touches the floor (Y==0). none <NoneType> DropToFloor() EndPoint : Get the position of the current actors endpoint. The endpoint is typically also the origin of an objects child. Its also a specified endpoint used for on-screen interactions and potentially for IK relationships. It also typically ends a line along the first rotation (twist) axis. none (<FloatType> x, <FloatType> y, <FloatType> z) EndPoint() GeomFileName Returns the filename of the geometry bring used by the figure, if any. none <StringType> figure.GeomFileName() Geometry Get the geometry for the actor. The returned geometry object can then be queried for vertex, set, or polygon information. none <GeomType> Geometry() HairGroup Get the hair group specified by the index. Enter the index of the desired hair group.
Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments
61

Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax <HairType> HairGroup(<IntType> index) InternalName
Get the (internal) name for the actor. The specified string is a unique name ID internal to Poser. none <StringType> InternalName() IsBase Return true only if the actor is a base. Bases are targets of deformation for deformers such as magnets. none <IntType> IsBase() IsBodyPart Return true only if the actor is a body part. none <IntType> IsBodyPart() IsCamera Return true only if the actor is a camera. none <IntType> IsCamera() IsDeformer Return true only if the actor is a deformer. none <IntType> IsDeformer() IsHairProp Return true only if actor is a hair prop. none <IntType> IsHairProp() IsLight Return true only if the actor is a light. none <IntType> IsLight()
62

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax IsProp Return true only if the actor is a prop. none <IntType> IsProp() IsZone
Return true only if the actor is a zone. Zones are regions acted upon by deformers such as magnets. none <IntType> IsZone() ItsFigure Get the figure of which this actor is a part. The return value is a figure object. none <FigureType> ItsFigure() JointVertexWeights Get a list of vertex weights for the specified joint axis on this actor. The axis argument should be x, y, or z. If no such joint is present, the method will return None. <FloatType list> JointVertexWeights(<StringType> axis) actor.JointVertexWeight(X) LightType Get the type of the light (if the current actor is a light). Possible light types are infinite (0), spot(1), point(2), image(3). none <IntType> LightType() LoadMaterialCollection Load a material collection for this actor. Enter the file name of the material collection you wish to load. <NoneType> LoadMaterialCollection(<StringType> FileName) LocalDisplacement Get a tuple comprising the local displacement for this actor. none (<FloatType> tx, <FloatType> ty, <FloatType> tz ) LocalDisplacement()
63

Method Name Explanation LocalMatrix
Get the local matrix for the actor. The local matrix is the matrix that describes the models relative relationship to its parent in the hierarchy. Thus the final world matrix of an object is made by concatenating its parents world matrix with its local matrix to produce its world matrix. none <FloatType 4x4 Tuple> LocalMatrix() LocalQuaternion Get a tuple comprising the quaternion local rotation for this actor. none (<FloatType> qw, <FloatType> qx, <FloatType> qy, <FloatType> qz ) LocalQuaternion() MarkGeomChanged Sets and internal flag on actor noting that the geometry has been changed. This method should be called after geometry changes so they will be stored properly. none <NoneType> MarkGeomChanged() Material Get a material object by its name. The string argument should typically be a name displayed in the Poser GUI material pull-down menu (e.g. skin). The call searches all materials available to this actor. Enter a valid material name. <MaterialType> FindMaterialByName(<StringType> name) skinMat = actor.FindMaterialByName(skin) Materials Get a list of the materials available to the actor. Note that these materials may actually belong to a parent figure. none <MaterialType List> Materials() matsList Memorize Set the actors default parameter values to the current values so that the actor can be reset later (See actor.Reset()). none <NoneType> Memorize() = actor.Materials()
Method Name Explanation Arguments Syntax Method Name Explanation
Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax
64
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
Name Get the (external) name for the current actor. The specified name is the same one seen in Posers GUI pull-down menus. none <StringType> Name() NextKeyFrame Get the next frame in which the parameter has a key frame set. none <IntType> NextKeyFrame() NumHairGroups Returns the number of hair groups. none <IntType> NumHairGroups() OnOff Query the display status of the actor in the scene. Returns 1 if actor is currently displayed, and 0 if actor is not currently displayed. none <IntType> OnOff() Orientation Get the orientation of the actors coordinate system (x,y,z ordered rotation). none (<FloatType> x, <FloatType> y, <FloatType> z) Orientation() Origin Get the position of the current actors origin in world space. none (<FloatType> x, <FloatType> y, <FloatType> z) Origin() Parameter Get the named parameter object. The string argument is the external parameter name (e.g. TranslationX). Enter a valid parameter name <ParmType> Parameter(<StringType> parmName)
65

Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax parm = Parameter(TranslationX) PrevKeyFrame
Get the previous frame in which the parameter has a key frame set. none <IntType> PrevKeyFrame() ParameterByCode Get the first parameter object matching the given code. Typical code values are constants defined as poser member variables (such as poser.kParmCodeXTRAN). Enter a valid parameter code. <ParmType> ParameterByCode(<IntType> parmCode) parm = ParameterByCode(poser.kParmCodeXSCALE) Parameters Get the settable parameters for the current actor. The return value is a list of parameter objects such as those depicted in Posers GUI dials (e.g. TranslationX). none <ParmType List> Parameters() Parent Get the parent actor of the current actor. none <ActorType> Parent() PointAt Set the target actor for this actor to point towards. Enter the actor that you wish this actor to point at. <NoneType> SetPointAt(<ActorType> target) eye.PointAt(targetActor) RayTraceShadows Query whether this light (if this actor is a light) is using Raytracing for shadows. none <IntType> RayTraceShadows()
66

Method Name Explanation RemoveValueParameter
Remove a value parameter from an actor. This type of parameter is not linked to Poser elements such as figures, props, etc. Rather, it can be used to add user interface control to your Python scripts. Enter the name of the parameter you wish to delete. <NoneType> RemoveValueParameter(<StringType> valueParmName) actor.RemoveValueParameter(MyNewParameter) Reset Reset the actor to its default, or last memorized, values (See actor.Memorize()). none <NoneType> Reset() SaveMaterialCollection Save the material collection of this actor. Enter the file name for the material collection. <NoneType> SaveMaterialCollection(<StringType> FileName) ScaleMatrix Get the scale matrix for the actor. none <FloatType 4x4 Tuple> ScaleMatrix() SetAlignmentRotationXYZ Set the tuple comprising the ordered rotation alignment for this actor. Enter valid floating-point values for X, Y, and Z rotation (order is X, Y, and Z). Angles are in degrees. <NoneType> SetAlignmentRotationXYZ(<FloatType> Rx, <FloatType> Ry, <FloatType> Rz ) actor.SetAlignmentRotationXYZ(4.53, 7.61, 1.01) SetAmbientOcclusion Set whether this light (if this actor is an image light) is using ambient occlusion. Enter 1 to use ambient occlusion, or 0 to disable ambient occlusion for this light. <NoneType> SetAmbientOcclusion(<IntType> ambientocclusion) SetAmbientOcclusionBias Set the ambient occlusion bias of this light (if this actor is an image light).
Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation
67

Arguments Syntax Method Name Explanation Arguments Syntax Enter the desired bias for this light.
<NoneType> SetAmbientOcclusionBias(<FloatType> bias) SetAmbientOcclusionDistance Set the ambient occlusion maximum distance of this light (if this actor is an image light). Enter the desired maximum distance for this light. <NoneType> SetAmbientOcclusionDistance(<FloatType> distance) SetAmbientOcclusionStrength Set the ambient occlusion strength of this light (if this actor is an image light). Enter the ambient occlusion strength value. <NoneType> SetAmbientOcclusionStrength(<FloatType> strength) SetAtmosphereStrength Set the atmosphere strength for this light (if this actor is a light). Atmosphere strength value. <NoneType> SetAtmosphereStrength(<FloatType> atmStrength) actor.SetAtmosphereStrength(0.15) SetBackfaceCull Set the actor's backface culling flag. Enter 1 to activate backface culling during rendering, or 0 to disable backface culling. <NoneType> SetBackfaceCull(<IntType> on = 1) SetBends Sets the actors bend flag. Enter 1 to set the flag, 0 to disable it. <NoneType> SetBends({<IntType> bends=<1 or 0>}) SetBends(bends=1) SetCastShadows Set whether this actor casts shadows. Enter 1 to cast shadows, or 0 to disable shadows. <NoneType> SetCastsShadows(<IntType> Cast) SetDisplacementBounds
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name
68

Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Set the actor's displacement bounds. Displacement bounds value.
<NoneType> SetDisplacementBounds(<FloatType> dispBounds) actor.SetDisplacementBounds(0.9) SetDisplayStyle Set the display style to be used for this actor. Typical display code constants are defined as poser member variables (e.g. poser.kDisplayCodeWIREFRAME). Enter a valid display code. <NoneType> SetDisplayStyle(<IntType> displayCode) actor.SetDisplayStyle(poser.kDisplayCodeFLATLINED) SetEndPoint Set the position of the endpoint of the actor. Typically the endpoint is the origin of an objects child. Its also a specified endpoint used for on screen interactions and potentially for IK relationships. It also typically ends a line along the first rotation (twist) axis.) Enter valid X, Y, and Z coordinates. <NoneType> SetEndpoint(<FloatType> x, <FloatType> y, <FloatType> z) actor.SetEndpoint(5.38, 3.90, 1.23) SetGeometry Set the geometry for the actor. The actor then takes on the appearance of the given geometry. Valid geometry objects can be taken from other actors or created from scratch with poser.NewGeometry(). Specify a valid Poser geometry object. <NoneType> SetGeometry(<GeomType> geometry) actor.SetGeometry(geom) SetIncludeInBoundingBox Set to determine inclusion in scene bounding box calculations. Default argument is set to 1, specifying that the actor should be included. Argument should be set to 0 to exclude actor. Enter 1 to include the actor, or 0 to exclude it. <NoneType> SetIncludeInBoundingBox({<IntType> on = 1}) actor.SetIncludeInBoundingBox(1) SetLightType Set the type of the light to a specified value. Typical values are constant light codes
69
defined as poser member variables such as poser.kLightCodeINFINITE. Arguments Syntax Example Method Name Explanation Arguments Syntax Enter a valid light code. <NoneType> SetLightType(<IntType> lightTypeCode) actor.SetLightType(poser.kLightCodeSPOT) SetLocalTransformCallback Set a per-update callback to process the actors local transformation. User-defined callback function is called every time actor undergoes a local transform. The callback function should take an actor argument and make desired changes to that actor. <NoneType> SetLocalTransformCallback(<FunctionType> newCB, {<Object> cbArgs}) SetName Renames the current actor. Enter a valid actor name <NoneType> actor.setName(<StringType> ActorName) actor.setName(MyNewActor) SetOnOff Set the display status of the current actor in the scene. The argument should be set to 1 to display the actor and 0 to turn actor display off. Enter 1 to display the actor, or 0 to toggle it off. <NoneType> SetOnOff(<IntType> on) actor.SetOnOff(0) SetOrientation Set the orientation of the actors coordinate system in x, y, z ordered rotation. Enter valid X, Y, and Z coordinates. <NoneType> SetOrientation(<FloatType> x, <FloatType> y, <FloatType> z) actor.SetOrientation(1.83, 4.0, 2.47) SetOrigin Set the position of the actors origin in world space. Enter valid X, Y, and Z coordinates. <NoneType> SetOrigin(<FloatType> x, <FloatType> y, <FloatType> z) actor.SetOrigin(1.83, 4.0, 2.47)
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example
70

Method Name Explanation Arguments SetParameter
Set the current value of the parameter. The string argument is the external parameter name (e.g. TranslationX). Parameter Name: Enter a valid parameter name. Value: Enter a valid value for the selected parameter.
<NoneType> SetParameter(<StringType> parmName, <FloatType> value) actor.SetParameter(poser.kParmCodeXSCALE,75) SetParent Set the specified actor as the parent of the current actor. If inheritBends is 1, this actor will acquire the bend parameters of the parent. If Realign is 1, this actor will be realigned to the local space of the parent. New Parent: The actor that will become the new parent of this actor. Inherit Bends: Defaults to 0. Enter 1 to specify that this actor should inherit the bends from the new parent. Realign: Defaults to 0. Enter 1 to specify that this actor should be realigned to conform to the new parent.
Arguments
<NoneType> SetParent(<ActorType> newParent, {<IntType> inheritBends = 0, <IntType> realign = 0}) childActor.SetParent(ParentActor, 1, 0) SetRangeConstant Set the given frame range to have constant (step) interpolation between keyframes for all parms of this actor. Note: automatically sets keyframes at start and end of specified range. Enter valid start and end frame numbers. <NoneType> SetRangeConstant(<IntType> startFrame, <IntType> endFrame) actor.SetRangeConstant(12,40) SetRangeLinear Set the given frame range to have linear interpolation between key frames for all parms of this actor. Note: automatically sets key frames at start and end of specified range. Enter valid start and end frame numbers. <NoneType> SetRangeLinear(<IntType> startFrame, <IntType> endFrame) actor.SetRangeLinear(12,40) SetRangeSpline
Arguments Syntax Example Method Name
71

Explanation
Set the given frame range to have spline interpolation between key frames for all parms of this actor. Note: automatically sets key frames at start and end of specified range Enter valid start and end frame numbers. <NoneType> SetRangeSpline(<IntType> startFrame, <IntType> endFrame) actor.SetRangeSpline(12,40) SetRayTraceShadows Set whether this light (if this actor is a light) is using raytracing for shadows. Enter 1 to use raytracing, or 0 to disable raytracing for this light. <NoneType> SetRayTraceShadows(<IntType> on = 1) SetShadingRate Set the actor's minimum shading rate. Minimum shading rate value. <NoneType> SetShadingRate(<FloatType> minShadingRate) actor.SetShadingRate(0.6) SetShadowBiasMax Set the maximum shadow bias for depth map shadows on this light (if this actor is a light). Maximum shadow bias value. <NoneType> SetShadowBiasMax(<FloatType> maxShadowBias) actor.SetShadowBiasMax(2.3) SetShadowBiasMin Set the minimum shadow bias for depth map shadows on this light (if this actor is a light). Minimum shadow bias value. <NoneType> SetShadowBiasMin(<FloatType> minShadowBias) actor.SetShadowBiasMin(0.3) SetShadowBlurRadius Set the shadow map blur radius for this light (if this actor is a light). Shadow blur radius value. <NoneType> SetShadowBlurRadius(<IntType> shadowBlurRad) actor.SetShadowBlurRadius(5)
Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example
72

Method Name Explanation Arguments Syntax Method Name Explanation SetSmoothPolys Set whether polygon smoothing is enabled for this actor.
Enter 1 to smooth polygons during rendering, or 0 to disable polygon smoothing. <NoneType> SetSmoothPolys(<IntType> Smooth) SetSplineBreak Set the given frame range to have spline interpolation between key frames for all parms of this actor. Note: automatically sets key frames at start and end of specified range Enter valid frame numbers then enter 1 for on and 0 for off. <NoneType> SetSplineBreak({<IntType> frame, <IntType> on}) actor.SetSplineBreak(12,0) SetStatic Set the status of static parameters on the actor. Argument defaults to 1, specifying that the actors parameters are static and will not change during animation. To specify non-static parameters, this function should be called with a 0 argument. Enter 1 to specify static parameters, or 0 to specify non-standard parameters <NoneType> SetStatic(<IntType> on = 1) actor.SetStatic(0) SetVertexCallback Set a per-update callback to process actor (vertices) while in local deformed space. The user-defined function will be called back on each full update of an actor and allows for manipulation of the vertices (or other information) at the point in the display pipeline of Poser which processes vertex level deformations. The callback function should take an actor object and make desired modifications to it. <NoneType> SetVertexCallback(<FunctionType> newCB, {<Object> cbArgs}) (See sample script) SetVisibleInReflections Set whether this actor is visible in reflections. Enter 1 to make actor visible in reflections during rendering, or 0 to make it invisible. <NoneType> SetVisibleInReflections(<IntType> on = 1) SetVisibleInRender Set whether this actor is visible in renders. Enter 1 to make actor visible in the rendered image, or 0 to make it invisible. <NoneType> SetVisibleInRender(<IntType> on = 1)
Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
73
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments
ShadingRate Get the actor's minimum shading rate. none <FloatType> ShadingRate() ShadowBiasMax Get the maximum shadow bias for depth map shadows on this light (if this actor is a light). none <FloatType> ShadowBiasMax() ShadowBiasMin Get the minimum shadow bias for depth map shadows on this light (if this actor is a light). none <FloatType> ShadowBiasMin() ShadowBlurRadius Get the shadow map blur radius for this light (if this actor is a light). none <IntType> ShadowBlurRadius() SmoothPolys Query whether polygon smoothing is enabled for this actor. none <IntType> SmoothPolys() SpawnTarget Creates a new morph channel on the object using the current state of the vertices. Typically used when while an actor is being deformed. Enter a name for the new morph channel. <NoneType> SpawnTarget(<StringType> label actor.SpawnTarget(MyNewMorphTarget) SpawnTargetFromGeometry Creates a new morph channel on the object using a geometry. The geometry argument is the deformation target, and the label provides a name for the new morph channel.
74

<NoneType> SpawnTargetFromGeometry(<GeomType> geometry, <StringType> label) actor.SpawnTargetFromGeometry(geom, MyMorphTarget) Static Get the status of the current actors static parameters. A return value of 1 means that the actor has static parameters, while a return value of 0 means that the parameters are not static. none <IntType> Static() TwistVertexWeights Get a list of vertex weights for the specified twist axis on this actor. The axis argument should be x, y, or z. If no such joint is present, the method will return None. <FloatType list> TwistVertexWeights(<StringType> axis) actor.TwistVertexWeight(X) ValueParameter Get a value parameter from the universe actor. This type of parameter is not linked to Poser elements such as figures, props, etc. Rather, it can be used to add user interface control to your Python scripts. Enter a valid parameter name. <ParmType> ValueParameter(<StringType> valueParmName) parm = actor.ValueParameter(MyNewParameter) ValueParameters Get a list of value parameters from the universe actor. This type of parameter is not linked to Poser elements such as figures, props, etc. Rather, it can be used to add user interface control to your Python scripts. none <ParmType List> ValueParameters() VisibleInReflections Query whether this actor is visible in reflections. none <IntType> VisibleInReflections() VisibleInRender Query whether this actor is visible in renders.
Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation
75

Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation none <IntType> VisibleInRender() WeldGoalActors
Get a list of actors that are welded to this one. Weld goal actors share edge vertices with this actor and are used to allow for geometric continuity when limbs bend. none <ActorType List> WeldGoalActors() WeldGoals Get a list of vertex index lists that specify the weld goals for this actor. Each vertex index list corresponds to a weld goal actor with the same index. And each such list is composed of vertex indices into that weld goal actors geometry. Each index list contains as many indices as the geometry of this actor contains vertices, but list items corresponding to vertices with no weld goals are filled with -1s. none <List of IntType Lists> WeldGoals() WorldDisplacement Get a tuple comprising the World displacement for this actor. none (<FloatType> tx, <FloatType> ty, <FloatType> tz) WorldDisplacement() WorldMatrix : Get the world matrix for the actor. The world matrix is the final complete matrix which transforms geometry from its original model space to its final world space. none <FloatType 4x4 Tuple> WorldMatrix() WorldQuaternion Get a tuple comprising the quaternion world rotation for this actor. none (<FloatType> qw, <FloatType> qx, <FloatType> qy, <FloatType> qz ) WorldQuaternion() Zones If the actor is a zone, this method returns the list of zones. none <ActorType List> ActorZones()
76
FIGURE METHODS
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Actor Get an actor, given its name. This is the name given in Posers GUI pull-down menus. Enter a valid actor name using the Poser external name. <ActorType> Actor(<StringType> name) fig.Actor(LeftForearm) ActorByInternalName Get an actor, given its internal name. This is a unique identifying string stored internally by Poser. Enter a valid internal name. <ActorType> Actor(<StringType> name) fig.ActorByInternalName(LeftForearm) Actors Get a list of actor objects comprising this figure. none <ActorType List> Actors() ClearStartupScript Specify that no Python script is to be associated with this figure. none. <NoneType> ClearStartupScript() ConformTarget Return the figure whose pose this figure is set to conform to. none. <FigureType> ConformTarget() ConformTo
Please use the SetConformTarget() method instead. Method Name Explanation Arguments Syntax DisplayStyle Get the interactive display style for this figure. Typical return values correspond to poser member variable constants (such as poser.kDisplayCodeWIREFRAME). none <IntType> DisplayStyle()
77

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation DropToFloor
Lower the figure (along the Y-axis) until it just touches the floor (y=0). none <NoneType> DropToFloor() FigureMeasure Measures hip height and feet distance. none <NoneType> FigureMeasure() GeomFileName Returns the filename of the geometry being used by the current actor, if any. none <StringType> GeomFileName() IkNames Get a list of names of inverse kinematics chains for the figure. The index of each name is the index used to get or set the status of the chain using IkStatus() or SetIkStatus(). none <StringType list> IkNames() IkStatus Get the status of inverse kinematics for the specified IK chain index. Enter an index between 0 and figure.NumIkChains() <IntType> IkStatus(<IntType> whichLimb) leftLegOn = figure.IkStatus(0) InternalName Get the internal name for the figure. This is a unique identifying string stored internally by Poser. none <StringType> InternalName() Material Get a material object by its name. The string argument should typically be a name displayed in the Poser GUI material pull-down menu (e.g. skin). The call searches all materials available to this actor. Enter a valid material name. <MaterialType> FindMaterialByName(<StringType> name)
Arguments Syntax
78

Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
skinMat = actor.FindMaterialByName(skin) Materials Get a list of material objects available to this figure. none <MaterialType List> Materials() Memorize Set the figures default parameter values to the current values so that the figure can be reset to this pose later (See figure.Reset()). none <NoneType> Memorize() Name Get the figures external name. This is the name given in Posers GUI pull-down menus. none <StringType> Name() NunIkChains Get the number of inverse kinematics chains attached to this figure.. none <IntType> NumIkChains() ParentActor Get the parent actor of the figure. Initially, the parent of a figure is typically the Body actor. none <ActorType> ParentActor() Reset Reset figure to default or last memorized pose. (See figure.Memorize(). none <NoneType> Reset() SetConformTarget Pose this figure to match the specified figures pose. Enter the figure to conform to. <NoneType> SetConformTarget(<FigureType> conformee)
79

Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation SetConformTarget(Figure1) SetDisplayStyle Set display style of the figure. Enter a valid display code.
<NoneType> SetDisplayStyle(<IntType> displayCode) fig.SetDIsplayStyle(poser.kDIsplayCodeFLATLINED) SetIkStatus Set the status of inverse kinematics for the specified IK chain index. Enter an index between 0 and figure.NumIkChains(), as well as a value specifying the status (0 for off, 1 for on). <NoneType> SetIkStatus(<IntType> whichLimb, <IntType> on) figure.SetIkStatus(0, 1) SetMeAsStartupScript Specify the current script as the Python script associated with the current Poser doc and executed on startup when the document is re-opened. none fig.SetMeAsStartupScript() SetOnOff Hide/show the figure. A value of 1 corresponds to on while a value of 0 corresponds to off Enter 1 to toggle the current figure visible, or 0 to toggle it invisible. <NoneType> SetOnOff(<IntType> on) fig.SetOnOff(1) SetParentActor Set the parent actor of the figure. The entire figure will be affected by parameter changes to its parent. Initially, the parent of a figure is typically the Body actor. Enter an actor which is to become the new parent of the figure. <NoneType> SetParentActor(<ActorType> newParent) fig.SetParentActor(someActor) SetStartupScript Specify the Python script to associate with the current Poser document and executed on startup when the file is re-opened. The filename should be a path (either absolute or relative to the Poser folder).
80

Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Enter the complete path and file name.
<NoneType> SetStartupScript(<StringType> filePath) fig.SetStartupScript(Runtime\Python\script.py) SetVisible Set the display status of the figure in the scene. Enter 1 to display the figure, and 0 to turn figure display off. <NoneType> SetVisible(<IntType> visible) StartupScript Return the Python script to be associated with the current Poser document and executed on startup when the document is reopened. The returned filename is a path (either absolute or relative to the Poser folder). none <StringType> StartupScript() StraightenBody Straighten the figures torso area. none <NoneType> StraightenBody() SwapBottom Swap the orientations of the bottom left and bottom right body parts. none <NoneType> SwapBottom() SwapTop Swap the orientations of the top left and top right body parts. none <NoneType> SwapTop() SymmetryBotLeftToRight Copy the bottom left side parameters of the figure to the bottom right side. Defaults to 0. Enter a value of 1 to specify that the joints should be copied. <NoneType> SymmetryBotLeftToRight({<IntType> copyJoints}) fig.SymmetryBotLeftToRight(1) SymmetryBotRightToLeft
Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name
81

Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation
Copy the bottom left side parameters of the figure to the bottom right side. Defaults to 0. Enter a value of 1 to specify that the joints should be copied. <NoneType> SymmetryBotRightToLeft({<IntType> copyJoints}) fig.SymmetryBotRightToLeft(1) SymmetryLeftToRight Copy the left side parameters of the figure to the right side. Defaults to 0. Enter a value of 1 to specify that the joints should be copied. <NoneType> SymmmetryLeftToRight({<IntType> copyJoints}) fig.SymmetryLeftToRight(1) SymmetryRightToLeft Copy the right side parameters of the figure to the left side. Defaults to 0. Enter a value of 1 to specify that the joints should be copied. <NoneType> SymmmetryRightToLeft({<IntType> copyJoints}) fig.SymmetryRightToLeft(1) SymmetryTopLeftToRight Copy the top left side parameters of the figure to the top right side. Defaults to 0. Enter a value of 1 to specify that the joints should be copied. <NoneType> SymmetryTopLeftToRight({<IntType> copyJoints}) fig.SymmetryTopLeftToRight(1) SymmetryTopRightToLeft Copy the top left side parameters of the figure to the top right side. Defaults to 0. Enter a value of 1 to specify that the joints should be copied. <NoneType> SymmetryTopRightToLeft({<IntType> copyJoints}) fig.SymmetryTopRightToLeft(1) UnimeshInfo Get a 3-item tuple containing as its first item the geometry of this figure as a single mesh. The second item is a list of actors comprising this figure. The third item is a peractor-vertex-info list. Each item in this list (size of numActors) is a list of vertex indices, specifying the mapping from the original actor vertices, to the vertices of the unimesh geometry. none (<GeomType>, <actor-list>, <per-actor-vertex-info-list>) UnimeshInfo() Click the GeomMods button and look for UnimeshDemo sample script.
82
Visible Query the display status of the figure in the scene. Returns 1 if the figure is currently displayed, and 0 if the figure is not currently displayed. none <IntType> Visible()
MATERIAL METHODS
Method Name Explanation Arguments Syntax AmbientColor Get the materials ambient color in the format RGB (values between 0.0 and 1.0). none (<FloatType> r, <FloatType> g, <FloatType> b) AmbientColor() BumpMapFileName Get the materials bump map filename. none <StringType> BumpMapFileName() BumpStrength Get the materials bump strength value. none <FloatType> BumpStrength() DiffuseColor Get the materials diffuse color in the format RGB (values between 0.0 to 1.0). none (<FloatType> r, <FloatType> g, <FloatType> b) DiffuseColor() LoadMaterialSet Load a material from the Library. Specify the name of the material you wish to load. <NoneType> LoadMaterialSet(<StringType> name) Name Get the materials internal name. none
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
Method Name Explanation Arguments Syntax Method Name Explanation Arguments
83

Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax <StringType> Name() Ns
Get the materials Ns value. An Ns value is an exponent used in calculating the specular highlight. A higher exponent results in a smaller highlight and vice-versa. none <FloatType> Ns() ReflectionColor Get the materials reflection color in the format RGB (values from 0.0 to 1.0). none (<FloatType> r, <FloatType> g, <FloatType> b) ReflectionColor() ReflectionMapFileName Get the materials reflection map filename. none <StringType> ReflectionMapFileName() ReflectionStrength Get the materials reflection strength value. none <FloatType> ReflectionStrength() SaveMaterialSet Save this material to the Library. Specify the name of the material you wish to save. <NoneType> SaveMaterialSet(<StringType> name) Selected Query whether this material is selected. Use material selection in conjunction with the Actor. none <IntType> Selected() SetAmbientColor Set the materials ambient color. none <NoneType> SetAmbientColor(<FloatType> r, <FloatType> g,
84

<FloatType> b) Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments SetBumpMapFileName Set the materials bump map filename. Enter a valid path and filename.
<NoneType> SetBumpMapFileName(<StringType> filePath) mat.SetBumpMapFilename(E:\Materials\Stone1.bmp) SetBumpStrength Set the material bump strength to a specific value. Enter a value between 1.0 and 1.0. <FloatType> SetBumpStrength(<FloatType> value) mat.SetBumpStrength(0.5) SetDiffuseColor Set the materials diffuse color. R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0.
<NoneType> SetDiffuseColor(<FloatType> r, <FloatType> g, <FloatType> b) mat.SetDiffuseColor(0.46,0.57,0.33) SetNs Set the materials Ns to a specific value. This is an exponent used in the calculation of the specular highlight. A higher exponent results in a smaller highlight and viceversa. Enter an exponent value. <FloatType> SetNs(<FloatType> value) mat.SetNs(0.5) SetReflectionColor Set the materials reflection color. R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0.
Syntax
<NoneType> SetReflectionColor(<FloatType> r, <FloatType> g, <FloatType> b)
85

Example Method Name Explanation Arguments Syntax Example mat.SetReflectionColor(0.46,0.57,0.33) SetReflectionMapFileName Set the materials reflection map filename. Enter a valid path and file name.
<NoneType> SetReflectionMapFileName(<StringType> filePath) mat.SetReflectionMapStrength(C:\My Documents\myrefmap.bmp) SetReflectionStrength Set the materials reflection strength to a specific value. Enter a value between 1.0 and 1.0. <FloatType> SetReflectionStrength(<FloatType> value) mat.SetReflectionStrength(0.5) SetSelected Selects or deselects the material. A value of 1 selects the material, a value of 0 deselects. Use material selection in conjunction with the Actor. Enter a value of either 1 or 0. <NoneType> SetSelected(<IntType> selected) SetSpecularColor Set the materials specular highlight color. R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0.
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments
Syntax Example Method Name Explanation Arguments
<NoneType> SetSpecularColor(<FloatType> r, <FloatType> g, <FloatType> b) mat.SetSpecularColor(0.46,0.57,0.33) SetTextureColor Set the material texture color in the format RBG. R: Enter the red value from 0.0 to 1.0. G: Enter the green value from 0.0 to 1.0. B: Enter the blue value from 0.0 to 1.0. <NoneType> SetTextureColor(<FloatType> r, <FloatType> g, <FloatType> b, <FloatType> ) mat.SetTextureColor(0.46,0.57,0.33) SetTextureMapFileName
Syntax Example Method Name
86

Explanation Arguments Syntax Example Method Name Explanation Set the materials texture map filename. Enter the path and file name.
<NoneType> SetTextureMapFileName(<StringType> filePath) mat.SetTexttureMapFileName(C:\Files\Textures\ tex1.bmp) SetTransparencyExpo Set the materials tExpo to a specific value. The tExpo parameter corresponds to the falloff of the the rate at which the transparency becomes opaque on the edges of an object. Enter a value between 0.0 and 10.0. <FloatType> SetTExpo(<FloatType> value) mat.SetTExpo(5.0). SetTransparencyMapFileName Set the materials transparency map filename. Enter the path and filename. <NoneType> SetTransparencyMapFileName(<StringType> filePath) mat.SetTransparencyMapFileName(C:\Files\ trans1.bmp) SetTransparencyMax : Set the materials tMax to a specific value. The tMax parameter is the maximum transparency allowable. A high TransparencyMax value makes the object very transparent in parts of the surface which face the eye. Enter a value between 0.0 and 1.0. <FloatType> SetTMax(<FloatType> value) mat.SetTMax(0.5) SetTransparencyMin Set the materials tMin to a specific value. The tMin parameter is the minimum transparency allowable. A high TransparencyMin value makes the objet very transparent on its edges. Enter a value between 0.0 and 1.0. <FloatType> SetTMin(<FloatType> value) mat.SetTMin(0.5) ShaderTree Get the materials shader tree. none
Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation
87

Syntax Method Name Explanation Arguments Syntax <ShaderTreeType> ShaderTree() SpecularColor
Get the materials specular highlight color in the format RGB (values between 0.0 and 1.0). none (<FloatType> r, <FloatType> g, <FloatType> b) SpecularColor() TextureColor Get the materials texture color in the format RG (values from 0.0 and 1.0). none (<FloatType> r, <FloatType> g, <FloatType> b) TextureColor() TextureMapFileName Get the materials texture map filename. none <StringType> TextureMapFileName() TransparencyExpo Get the materials tExpo value. The TransparencyExpo value determines the rate at which the transparency becomes opaque on the edges of an object. none <FloatType> TExpo() TransparencyMapFileName Get the materials transparency map filename. none <StringType> TransparencyMapFileName() TransparencyMax Get the tMax value for the material. A high TransparencyMax value makes the object very transparent in parts of the surface which face the eye. none <FloatType> TMax() TransparencyMin Get the tMin value for the material. A high TransparencyMin value makes the object very transparent on its edges.
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation
88

Arguments Syntax none <FloatType> TMin()
PARAMETER METHODS
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Actor Return the actor which owns this parm. none <ActorType> Actor() AddKeyFrame Add a key frame for this parameter at the specified frame. If no frame is specified, a keyframe will be added at the current frame. Enter a valid frame number. <NoneType> AddKeyFrame({<IntType> frame}) AddKeyFrame(81) ApplyLimits Apply minimum and maximum limits to parameter. none <NoneType> ApplyLimits() ClearUpdateCallback Clear update callback for calculating this parameter value if it is set. none <NoneType> ClearUpdateCallback() ConstantAtFrame Query whether or not the given frame is within a constant range. If no frame is specified, the default frame is the current frame Optionally, enter a valid frame number. <IntType> ConstantAtFrame({<IntType> frame}) parm.ConstantAtFrame(12) DeleteKeyFrame Delete a key frame for this actor at the specified frame. If no frame is specified, a keyframe will be deleted at the current frame. Enter a valid frame number. <NoneType> DeleteKeyFrame({<IntType> frame})
89

Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation parm.DeleteKeyFrame(30) Hidden
Query whether or not the current parameter is hidden from the user interface (UI). Returns 1 if hidden, 0 if visible. none <IntType> Hidden() InternalName Get the parameters internal name. none <StringType> InternalName() IsMorphTarget Query whether or not this parameter is a morph target parameter. Returns 1 if it is and 0 if it is not. none <IntType> IsMorphTargetParamter() IsValueParameter Query whether or not this parameter is a value parameter. This type of parameter is not linked to Poser elements such as figures, props, etc. Rather, it can be used to add user interface control to your Python scripts. Returns 0 if not a value parameter, 1 if yes. none <IntType> IsValueParamter() LinearAtFrame Query whether or not the given frame is within a linear range. If no frame is specified, the default frame is the current frame. Optionally, enter a valid frame number. <IntType> LinearAtFrame({<IntType> frame}) parm.LinearAtFrame(12) MaxValue Get the current parameters maximum value. none <FloatType> MaxValue() MinValue
Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name
90

Explanation Arguments Syntax Method Name Explanation Get the parameters current minimum value. none <FloatType> MinValue() MorphTargetDelta
If this parameter is a morph target parameter, return the morph target delta associated with the specified vertex index. Note: Deltas are 3D differences between the original geometry and the morphed geometry. none (<FloatType> deltaX, <FloatType> deltaY, <FloatType> deltaZ) MorphTargetDelta(<IntType> vertexIndex) Name Get the parameters external name. none <StringType> Name() NextKeyFrame Get the next frame in which the parameter has a key frame set. none <IntType> NextKeyFrame() PrevKeyFrame Get the previous frame in which the parameter has a key frame set. none <IntType> PrevKeyFrame() Sensitivity Get the sensitivity of the mouse tracking (on the user interface). none <FloatType> Sensitivity() SetHidden Set the hidden status of this parameter. 0: Set the parameter as visible. 1: Set the parameter as hidden.
Arguments Syntax
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments
Syntax Example
<NoneType> SetHidden(<IntType> hide) parm.SetHidden(1)
91

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation SetInternalName Set the parameters internal name. none <NoneType> SetInternalName() SetMaxValue Set the parameters maximum value. Enter a valid value for the current parameter.
<FloatType> SetMaxValue(<FloatType> value) parm.SetMaxValue(100.00) SetMinValue Set the parameters minimum value. Enter a valid value for the current parameter. <FloatType> SetMinValue(<FloatType> value) parm.SetMinValue(1.35) SetMorphTargetDelta If this parameter is a morph target parameter, set the morph target delta value associated with the specified vertex index. Note: Deltas are 3D differences between the original geometry and the morphed geometry. Vertex Index: Enter the array index that identifies the desired vertex. Delta X: Enter the change in the X component of the vertex. Delta Y: Enter the change in the Y component of the vertex. Delta Z: Enter the change in the Z component of the vertex.
Arguments
Syntax
<NoneType> SetMorphTargetDelta(<IntType> vertexIndex, <FloatType> deltaX, <FloatType> deltaY, <FloatType> deltaZ) parm.SetMorphTargetDelta( vertexIndex, 0.12, 0.34, 0.45) SetName Set the parameters external name. Enter a valid name for the current parameter. <NoneType> SetName(<StringType> name) parm.SetName(Test1) SetRangeSpline Set the given frame range to have spline interpolation between key frames. Automatically sets key frames at start and end of specified range.
Example Method Name Explanation Arguments Syntax Example Method Name Explanation
92

Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Enter a valid starting and ending frame.
<NoneType> SetRangeSpline(<IntType> startFrame, <IntType> endFrame) parm.SetRangeSpline(10,20) SetSensitivity Set the sensitivity of the mouse tracking (on the user interface). none <NoneType> SetSensitivity(<FloatType> value) SetUpdateCallback Set a per-update callback for calculating this parameter value. The callback function should take the parameter and the parameters current value as callbacks. <NoneType> SetUpdateCallback(<FunctionType> newCB, {<Object> cbArgs}) (See sample scripts) SetValue Set the parameter to a specific value. none <NoneType> SetValue(<FloatType> value) SplineAtFrame Query whether or not the given frame is within a spline range. If no frame is specified, the default frame is the current frame. Optionally, enter a valid frame number. <IntType> SplineAtFrame({<IntType> frame}) parm.SplineAtFrame(32) SetRangeConstant et the given frame range to have constant (step) interpolation between keyframes. Automatically sets key frames at start and end of specified. Enter valid start and end frame numbers. <NoneType> SetRangeConstant(<IntType> startFrame, <IntType> endFrame) parm.SetRangeConstant(12,32) SetRangeLinear
93

Explanation Arguments Syntax Example Method Name Explanation
Set the given frame range to have linear interpolation between key frames. Automatically sets key frames at start and end of specified range. Enter valid start and end frame numbers. <NoneType> SetRangeLinear(<IntType> startFrame, <IntType> endFrame) parm.SetRangeLinear(12,32) SetSplineBreak Break spline interpolation at the given frame. If the frame is not a keyframe, no action will be taken. If no frame is specified, the default frame is the current frame. A broken spline can be un-broken by passing a 0 as the second argument to this method. Enter a valid frame number. Optionally, add 0 to u-break the spline. <NoneType> SetSplineBreak({<IntType> frame, <IntType> on}) parm.SetSplineBreak(12,0) SplineBreakAtFrame Query whether or not the given frame is a spline-break. If the frame is not a keyframe, no action will be taken. If no frame is specified, the default frame is the current frame. Enter a valid frame number. <IntType> SplineBreakAtFrame({<IntType> frame}) parm. SplineBreakAtFrame(12) TypeCode Get the type code for this parameter. Type codes are enumerated values, such as poser.kParmCodeXROT. none <IntType> TypeCode() Value Get the parameters current value. none <FloatType> Value()
Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
GEOMETRY METHODS
Method Name Explanation AddGeneralMesh Add a general mesh to existing geometry. Arguments are numerical Python arrays specifying polygons, sets, and vertices, as well as optionally texture-polygons, texturesets, and texture-vertices. (See Numerical Python documentation for more details). Required:
Arguments
94
Polygons: Enter the Numerical array specifying the polygonal connectivity of the sets. Each polygon stores the starting set index and the number of vertices it contains. Sets: Enter the Numerical array containing the IDs of the vertices. Each ID is an integer corresponding to the position of the vertex in the vertex array. Vertices: Enter the Numerical array containing the actual positions of the vertices. Each vertex has an X, Y, and Z component.
Optional: Texture Polygons: Enter the Numerical array specifying the polygonal connectivity of the texture-sets. Each polygon stores the starting set index and the number of vertices it contains. Texture Sets: Enter the Numerical array containing the IDs of the texture vertices. Each ID is an integer corresponding to the position of the vertex in the vertex array. Texture Vertices: Enter the Numerical array containing the actual positions of the texture vertices. Each vertex has an X, Y, and Z component.
Syntax
<NoneType> AddGeneralMesh(<IntType nx2 Numeric.Array> polygons, <IntType nx1 Numeric.Array> sets, <FloatType nx3 Numeric.Array> vertices, {<IntType nx2 Numeric.Array> texPolygons, <IntType nx1 Numeric.Array> texSets, <FloatType nx3 Numeric.Array> texVertices}) See sample scripts. AddMaterialName Adds a material name to the geometry material name list and returns its index. Enter the name for the new material. <IntType> AddMaterialName(<StringType> name) j = geom.AddMaterialName(Chartreux) AddPolygon Add a polygon to existing geometry by providing a 2-dimensional nx3 numerical python array of vertices. (See Numerical Python documentation for more details). Returns the newly added polygon object. Enter a Numerical array containing the actual positions of the vertices for the new polygon. Each vertex has an X, Y, and Z component. <PolygonType> AddPolygon(<FloatType nx3 Numeric.Array> vertices) poly = geom.AddPolygon(newVerts) AddTriangle Add a triangle to existing geometry by specifying 3 points. Enter a tuple of tuples specifying the vertices of the new triangle to add.
Example Method Name Explanation Arguments Syntax Example Method Name Explanation
95

Syntax Example <StringType list> Groups()
poly = geom.AddTriangle((1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0)) Groups Get the list of group names for this geometry. Groups can be created using the grouping tool in the Poser GUI. none <StringType list> Groups() Materials Get a list of material objects of the geometry. none <MaterialType List> Materials() Normals Get a list of vertex normals. Each normal is a vertex object. none <VertType List> Normals() NumMaterials Get the number of materials in the geometry. none <IntType> NumMaterials() NumNormals Get the number of normals in the geometry. none <IntType> NumNormals() NumPolygons Get the number of polygons in the geometry. none <IntType> NumPolygons() NumSets Get the number of sets in the geometry. none
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments
96

Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax <IntType> NumSets() NumTexPolygons Get the number of texture polygons in the geometry. none <IntType> NumTexPolygons() NumTexSets Get the number of texture sets in the geometry. none <IntType> NumTexSets() NumTexVertices Get the number of texture vertices in the geometry.. none <IntType> NumTexVertices() NumVertices Get the number of vertices in the geometry. none <IntType> NumVertices() Polygon Get a polygon object by specifying its index. Enter a valid polygon index. <PolygonType> Polygon(<IntType> index) geom.Polygon(3) Polygons
Get a list of polygon objects. Each polygon object can be queried for a start set index as well as the number of vertices in the polygon. none <PolygonType List> Polygons() Sets Get a set list for the geometry. Each set value is an index into the vertex list. none <IntType List> Sets()
97
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments
TexPolygons Get a list of texture polygon objects. Each texture polygon object can be queried for a start set index as well as the number of vertices in the polygon. none <TexPolygonType List> TexPolygons() TexSets Get a texture set list for the geometry. Each texture set value is an index into the texture vertex list. none <IntType List> TexSets() TexVertices Get a list of texture vertex objects. Each vertex object can be queried for U and V values. none <TexVertType List> TexVertices() Vertex Get a (model space) vertex object by specifying its index. none <VertType> Vertex(<IntType> index) Vertices Get a list of vertex objects. Each vertex object can be queried for x,y,z values. none <VertType List> Vertices() Weld Share similar vertices. This call smoothes objects by homogenizing normals for coincident vertices. none <NoneType> Weld() WorldNormals Get a list of vertex normals in world space if possible. If no world space data is available, the function will return None. Each normal is a vertex object. None
98

Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax <VertType List> WorldNormals() WorldVertex
If possible, get a (world space) vertex object by specifying its index. If no world space data is available, the function will return None. none <VertType> WorldVertex(<IntType> index) WorldVertices Get the vertices of the geometry in world space if possible. If no world space data is available, the function will return None. none <VertType List> WorldVertices()
VERTEX METHODS
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax SetX Set X coordinate. Enter a valid coordinate. <NoneType> SetX(<FloatType> value) vert.SetX(4.11) SetY Set Y coordinate. Enter a valid coordinate. <NoneType> SetY(<FloatType> value) vert.SetY(2.25) SetZ Set Z coordinate. Enter a valid coordinate. <NoneType> SetZ(<FloatType> value) vert.SetZ(6.52) X Get X coordinate. none <FloatType> X()
99

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Y Get Y coordinate. none <FloatType> Y() Z Get Z coordinate. none <FloatType> Z()
POLYGON METHODS
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Groups Return a list of groups in which this polygon is included. Groups can be created using the grouping tool in the Poser GUI. none <StringType list> Groups() InGroup Determine if the polygon is in the specified group. Groups can be created using the grouping tool in the Poser GUI. Enter a valid group name. <IntType> InGroup(<StringType> groupName) poly.InGroup(MyNewGroup) IncludeInGroup Include the polygon in the specified group. Groups can be created using the grouping tool in the Poser GUI. Enter a valid group name. <NoneType> IncludeInGroup(<StringType> groupName) poly.IncludeInGroup(MyNewGroup) MaterialIndex Get the material index of the element. This is an index into the list of materials of this geometry object. none <IntType> MaterialIndex() MaterialName
100

Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Method Name Explanation Arguments Get the elements material name. none <StringType> MaterialName() NumVertices Get the number of vertices in the polygon. none <IntType> NumVertices() RemoveFromGroup
Remove the polygon from the specified group. Groups can be created using the grouping tool in the Poser GUI. Enter a valid group name. <NoneType> RemoveFromGroup(<StringType> groupName) poly.RemoveFromGroup(MyNewGroup) SetMaterialIndex Set the polygons material index. This is an index into the list of materials of this geometry object. Enter the index of the desired material. <NoneType> SetMaterialIndex(<IntType> index) poly.SetMaterialIndex(3) SetMaterialName Set the material name of the polygon, returns material index. Enter a name for the polygons material. <IntType> SetMaterialName(<StringType> name) poly.SetMaterialName(cotton) Start Get the starting set index of the element. Using this value to index into the set list, one can get the index of the associated vertex. none <IntType> Start() Vertices Get a list of vertex objects for the polygon. none
101

Syntax <VertType List> Vertices()
TEXPOLYGON METHODS
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax NumTexVertices Get the number of texture vertices in the geometry. none <IntType> NumTexVertices() Start Get the starting set index of the polygon. Using this value to index into the set list, one can get the index of the associated texture vertex. none <IntType> Start() TexVertices Get a list of texture vertex objects for the polygon. none <TexVertType List> TexVertices()
TEXVERTEX METHODS
Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax Example Method Name Explanation Arguments Syntax SetU Set U coordinate. Enter a U coordinate. <NoneType> SetU(<FloatType> value) Geom..SetU(.96) SetV Set V coordinate. Enter a V coordinate. <NoneType> SetU(<FloatType> value) geom.SetV(.96) U Get U coordinate. none <FloatType> U()
102
V Get V coordinate. none <FloatType> V()
SHADER TREE METHODS

This class of methods was introduced in Poser 6.0.0.
Method Name Explanation Arguments Syntax AttachTreeNodes Connect a ShaderNodes output to another ShaderNodes input. Specify the input to which you wish to connect (parameter), the node on which that input resides (node1), and the node whose output you are connecting (node2). <NoneType> AttachTreeNodes(<ShaderNodeType> node1, <StringType> parameter, <ShaderNodeType> node2) CreateNode Create a new ShaderNode. Specify the type of ShaderNode you wish to create. <ShaderNodeType> CreateNode(<StringType> type) DeleteNode Delete a node from the ShaderTree. Specify the number of the node you wish to delete. <NoneType> DeleteNode(<IntType> i) DetachTreeNode Detach a node from a specified input on a specified node. Specify the node, and the input from which it should be detached. <NoneType> DetachTreeNode(<ShaderNodeType> node, <StringType> parameter) Node Get the node number i in this ShaderTree. Specify the node number you wish to get. <ShaderNodeType> Node(<IntType> i) NodeByInternalName Get a ShaderNode by using its internal name.
Method Name Explanation Arguments Syntax Method Name Explanation
103

Specify the internal name of the ShaderNode you wish to get. <ShaderNodeType> NodeByInternalName(<StringType> name) Nodes Get a list of all nodes in this ShaderTree. none <ShaderNodeType list> Nodes() NumNodes Get the number of nodes in this ShaderTree. none <IntType> NumNodes() UpdatePreview Tell Poser that this ShaderTree has been modified. none <NoneType> UpdatePreview()
SHADER NODE METHODS

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation ConnectToInput Connect the output of this node to the given input Specify a node input <NoneType> ConnectToInput(<ShaderNodeInputType> Input) Delete Delete this node. (You must not use this ShaderNode object after deleting it.) none <NoneType> Delete() Input Get an input by means of its index. Enter an input index number. <ShaderNodeInputType> Input(<IntType> Index) InputByInternalName Get an input by means of its internal name.
104

Arguments Syntax Enter the internal name of the input you wish to access.
<ShaderNodeInputType> InputByInternalName(<StringType> inputName) Inputs Get a list of all inputs for the current node (the node upon which this method is called). none <ShaderNodeInputType list> Inputs() InputsCollapsed Query whether the nodes inputs are collapsed in the UI. none <IntType> InputsCollapsed() InternalName Get the internal name for the node. none <StringType> InternalName() Location Get the UI position of this node in pixels. none (<IntType> x, <IntType> y) Location() Name Get the (external) name of the node. none <StringType> Name() NumInputs Get the number of this ShaderNodes inputs. none <IntType> NumInputs() PreviewCollapsed Query whether the nodes preview is collapsed in the UI. none <IntType> PreviewCollapsed()
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
105
SetInputsCollapsed Set whether the nodes inputs are collapsed in the UI. Enter 1 to collapse inputs, and 0 to disable input collapse. <NoneType> SetInputsCollapsed(<IntType> Collapsed) SetLocation Set the UI position of this node in pixels. The x and y arguments specify the coordinates of the node location on the Material palette. <NoneType> SetLocation(<IntType> x, <IntType> y) SetName Set the (external) name of the node. Enter a string for the name <NoneType> SetName(<StringType> Name) Set PreviewCollapsed Set whether the preview is collapsed in the UI. Enter 1 to collapse the preview, or 0 to disable preview collapse. <NoneType> SetPreviewCollapsed(<IntType> Collapsed) Type Get the Type of this node. none <StringType> Type()
SHADER NODE INPUT METHODS

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Animated Returns 1 if the input is animated, 0 if it is not animated. none <IntType> Animated() CanBeAnimated Returns 1 if the input can be animated, 0 if the input cannot be animated. none <IntType> CanBeAnimated()
106
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
Disconnect Disconnects the node that is plugged into this input. none <NoneType> Disconnect() InNode Returns the shader node that is plugged into this input. Returns none if no shader node is plugged into this input. none <ShaderNodeType> InNode() InternalName Get the internal name of the shader node input. none <StringType> InternalName() ItsNode Returns the shader node to which this input belongs. none <ShaderNodeType> ItsNode() Name Get the (external) name of the shader node input. none <StringType> Name() Parameters Returns the parameter(s) if the input is animated. Depending on the type of input, the latter two return values may be set to None. none (<ParmType> r, <ParmType> g, <ParmType> b) Parameters() SetAnimated Set the animation status of this input. Set it to 1 for the input to be animated, 0 for it not to be animated. Enter a value of either 1 or 0. <NoneType> SetAnimated(<IntType> animated)
107

Method Name Explanation Arguments Syntax SetColor Set the value of a color or vector input. Specify the RGB value of the desired color.
<NoneType> SetColor(<FloatType> r, <FloatType> g, <FloatType> b) SetFloat Set the value of a float, integer, Boolean or menu input. Enter the value you wish to set. <NoneType> SetFloat(<FloatType> value) SetName Set the (external) name. Enter the desired name. <NoneType> SetName(<StringType> Name) SetString Set the string value. In this version of Poser, this is the path of a texture or movie file. Enter the path name for the desired texture or movie file. <NoneType> SetString(<StringValue> file) Type Get the type of data accepted by the current input. The types are defined as Poser member variables such as poser.kNodeInputCodeCOLOR. none <IntType> Type() Value Get the current value at the selected input. Depending on the type of input, the return value can be a float, a tuple of three floats, or a string. none <FloatType> Value() (<FloatType>, <FloatType>, <FloatType>) Value() <StringType> Value()
FIREFLY OPTIONS METHODS

Method Name BucketSize
108

Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Get the bucket size. none <IntType> BucketSize() DepthOfField
Query whether or not depth of field is enabled. A return value of 1 indicates that depth of field is enabled; a return value of 0 indicates that depth of field is disabled. none <IntType> DepthOfField() Displacement Query whether or not displacement is enabled. A return value of 1 indicates that displacement is enabled; a return value of 0 indicates that displacement is disabled. none <IntType> Displacement() DisplacementBounds Get the size of the displacement bounds. none <FloatType> DisplacementBounds() DrawToonOutline Query whether or not toon outlines are being drawn. A return value of 1 indicates that drawing is enabled; a return value of 0 indicates that toon outlines are turned off. none <IntType> DrawToonOutline() FilterSize Get the post filter size. none <IntType> FilterSize() FilterType Get the post filter type. none <IntType> FilterType() MaxRayDepth Get the maximum number of raytrace bounces.
109

Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments none <IntType> MaxRayDepth() MaxTextureRes Get the max texture resolution. none <IntType> MaxTextureRes() MinShadingRate Get the minimum shading rate. none <FloatType> MinShadingRate() MotionBlur
Query whether or not motion blur is enabled. A return value of 1 indicates that motion blur is enabled; a return value of 0 indicates that motion blur is disabled. none <IntType> MotionBlur() PixelSamples Get the number of samples per pixel. none <IntType> PixelSamples() RayTracing Query whether or not raytracing is enabled. A return value of 1 indicates that raytracing is enabled; a return value of 0 indicates that raytracing is disabled. none <IntType> RayTracing() Set BucketSize Set the bucket size. Enter the bucket size value. <NoneType> BucketSize(<IntType> size) SetDepthOfField Set whether depth of field is enabled. A value of 1 enables depth of field, and 0 disables it. Enter a value of either 1 or 0.
110

Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
<NoneType> SetDepthOfField(<IntType> depthoffield) SetDisplacement Set whether displacement is enabled. A value of 1 enables displacement, and 0 disables it. Enter a value of either 1 or 0. <NoneType> SetDisplacement(<IntType> displacement) SetDisplacementBounds Set the size of the displacement bounds. Enter a floating-point value that represents the displacement bounds. <NoneType> SetDisplacmentBounds(<FloatType> bounds) SetDrawToonOutline Set whether toon outlines are being drawn. A value of 1 enables toon outlines, and 0 disables them. Enter a value of either 1 or 0. <NoneType> SetDrawToonOutline(<IntType> drawoutlines) SetFilterSize Set the post filter size. Enter an integer value to represent the post filter size. <NoneType> SetFilterSize(<IntType> size) SetFilterType Set the post filter type. Enter the constant defined for the desired post filter type. <NoneType> SetFilterType(<IntType> type) SetMaxRayDepth Set the maximum number of raytrace bounces. Enter the desired maximum number. <NoneType> SetMaxRayDepth(<IntType> depth) SetMaxTextureRes Set the maximum texture resolution. Specify the maximum x and y resolution at which Poser will load figures. Both x and y share a single value. <NoneType> SetMaxTextureRes(<IntType> resolution)
111
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation
SetMinShadingRate Set the minimum shading rate. Specify the desired minimum shading rate. <NoneType> SetMinShadingRate(<FloatType> shadingrate) SetMotionBlur Set whether motion blur is enabled. A value of 1 enables motion blur, and 0 disables it. Enter a value of either 1 or 0. <NoneType> SetMotionBlur(<IntType> motionblur) SetPixelSamples Set the number of samples per pixel. Enter the desired sample value. <NoneType> SetPixelSamples(<IntType> numsamples) SetRayTracing Set whether raytracing is enabled. A value of 1 enables raytracing, and 0 disables it. Enter a value of either 1 or 0. <NoneType> SetRayTracing(<IntType> raytracing) SetShadowOnlyRender Set whether only shadows are being rendered. A value of 1 enables regular renders, and 0 enables shadow only renders. Enter a value of either 1 or 0. <NoneType> SetShadowsOnlyRender(<IntType> shadowsonly) SetShadows Set whether shadows are being rendered. A value of 1 enables shadow rendering, and 0 disables it. Enter a value of either 1 or 0. <NoneType> SetShadows(<IntType> doshadows) SetSmoothPolys Set whether polygons are being smoothed. A value of 1 renders polygons as smooth surfaces, and 0 renders polygons as flat surfaces. Note that this can be set per actor; see the description of Actor Type. Enter a value of either 1 or 0.
Arguments
112

Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation
<NoneType> SetSmoothPolys(<IntType> dosmoothing) SetTextureFiltering Set whether texture filtering is enabled. A value of 1 enables texture filtering, and 0 disables it. Enter a value of either 1 or 0. <NoneType> SetTextureFiltering(<IntType> filtering) SetToonOutlineStyle Set the toon outline style. Enter a constant representing the desired toon outline style. <NoneType> SetToonOutlineStyle(<IntType> outlinestyle) ShadowOnlyRender Queries whether or not only shadows are being rendered. A return value of 1 indicates a shadows only render, and a value of 0 indicates a regular render. none <IntType> ShadowOnlyRender() Shadows Queries whether or not shadows are being rendered. A return value of 1 indicates that shadows are being rendered, and a value of 0 indicates shadow rendering is disabled. none <IntType> Shadows() SmoothPolys Queries whether or not polygons are being smoothed. A value of 1 indicates polygons are being smoothed, and a value of 0 indicates that polygons are being rendered as flat surfaces. Note that this can be set per actor; see the description of Actor Type. none <IntType> SmoothPolys() TextureFiltering Queries whether or not texture filtering is enabled. A return value of 1 indicates that texture filtering is enabled, and a value of 0 indicates texture filtering is disabled. none <IntType> TextureFiltering() ToonOutlineStyle Queries for toon outline style.
113

Arguments Syntax none <IntType> ToonOutlineStyle()
HAIR METHODS
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation AirDamping Get the air damping value. none <FloatType> AirDamping() BendResistance Get the bend resistance. none <FloatType> BendResistance() CalculateDynamics Calculate this groups hair dynamics. Note that this may take quite some time, depending on the complexity of the hair group, the scene geometry and the animation length. none <ActorType> CalculateDynamics() Clumpiness Get the clumpiness value. none <FloatType> Clumpiness() CollisionsOn Determine whether this hair group reacts to collisions. A return value of 1 indicates collision detection is on, and a value of 0 indicates collision detection is off. none <IntType> CollisionsOn() Delete Delete the hair group and its associated hair prop. none <ActorType> Delete()
114

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Gravity Get the gravity value. none <FloatType> Gravity() GrowHair Grow guide hairs. none <NoneType> GrowHair() HairProp Get the prop that represents this hair group. none <ActorType> HairProp() KinkDelay Get the kink delay value. none <FloatType> KinkDelay() KinkScale Get the kink scale value. none <FloatType> KinkScale() KinkStrength Get the kink strength value. none <FloatType> KinkStrength() SetLengthMax Set the maximum length. Enter the desired maximum length.
<NoneType> SetLengthMax(<FloatType> value) SetLengthMin Set the minimum length.
115

Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Enter the desired minimum length.
<NoneType> SetLengthMin(<FloatType> value) SetName Set the name of this Hair. Specify the desired name. <StringType> SetName(<StringType> name) SetNumbPopHairs Set the total number of hairs. Enter the total hair number value. <NoneType> SetNumbPopHairs(<IntType> value) SetNumbVertsPerHair Set the number of vertices per hair. Enter the value for the number of vertices. <NoneType> SetNumbVertsPerHair(<IntType> value) SetPositionForce Set the PositionForce. Specify the PositionForce value as a floating-point number. <NoneType> SetPositionForce(<FloatType> value) SetPullBack Set the pull back parameter. Specify the pull back value as a floating-point number. <NoneType> SetPullBack(<FloatType> value) SetPullDown Set the pull down parameter. Specify the pull down value as a floating-point number. <NoneType> SetPullDown(<FloatType> value) SetPullLeft Set the pull left parameter. Specify the pull left value as a floating-point number. <NoneType> SetPullLeft(<FloatType> value)
116

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name SetRootStiffness Set the root stiffness. Specify the root stiffness as a floating-point number.
<NoneType> SetRootStiffness(<FloatType> value) SetRootStiffnessFalloff Set the root stiffness falloff. Specify the root stiffness falloff as a floating-point number. <NoneType> SetRootStiffnessFalloff(<FloatType> value) SetShowPopulated Set whether populated hair is shown. A value of 1 indicates that it is shown, and 0 indicates that it is not shown. Enter a value of either 1 or 0. <NoneType> SetShowPopulated(<IntType> value) SetSpringDamping Set the spring damping value. Specify the spring damping value as a floating-point number. <NoneType> SetSpringDamping(<FloatType> value) SetSpringStrength Set the spring strength value. Specify the spring strength value as a floating-point number. <NoneType> SetSpringStrength(<FloatType> value) SetWidth Set the hair width. Specify the hair width as a floating-point number. <NoneType> SetWidth(<FloatType> value) ShowPopulated Determine whether populated hair is shown. A return value of 1 indicates that it is shown, and a value of 0 indicates that it is not shown. none <IntType> ShowPopulated() SpringDamping
117

Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Get the spring damping value. none <FloatType> SpringDamping() SpringStrength Get the spring strength value. none <FloatType> SpringStrength() Width Get the hair width. none <FloatType> Width()
CLOTH SIMULATOR METHODS

Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax AddClothActor Add a clothified actor to this simulation. Specify the name of the actor you wish to add <NoneType> AddClothActor(<ActorType> actor) AddCollisionActor Add an actor as a collision object to this simulation. Specify the name of the actor you wish to add <NoneType> AddCollisionActor(<ActorType> actor) AddCollisionFigure Add a figure as a collision object to this simulation, excluding the group names in the list. Specify the name of the actor you wish to add, plus the list of group names you wish to exclude. <NoneType> AddCollisionFigure(<FigureType> figure, <StringType list> excludeList) CalculateDynamics Start the simulation calculation. none <NoneType> CalculateDynamics()
118
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name
ClearDynamics Clear the simulation dynamics cache. none <NoneType> ClearDynamics() CurrentClothActor Get the current cloth actor. none <ActorType> CurrentClothActor() Delete Removes this simulation from the scene. none <NoneType> Delete() DrapingFrames Get the number of draping frames in this simulation. none <IntType> DrapingFrames() DynamicsProperty Get the value of a named property. Property names are defined as Poser member variables such as poser.kClothParmDENSITY. Specify the property for which you want the value. <FloatType> DynamicsProperty(<StringType> Name) EndFrame Get the end frame of this simulation. none <IntType> EndFrame() IsClothActor Query whether this actor is a cloth actor in this simulation. A value of 1 indicates that it is a cloth actor, and a value of 0 indicates that it is not a cloth actor. Specify the name of the actor. <IntType> IsClothActor(<ActorType> actor) IsCollisionActor
119

Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation
Query whether this actor is a collision actor in this simulation. A value of 1 indicates that it is a collision actor, and a value of 0 indicates that it is not a collision actor. Specify the name of the actor. <IntType> IsCollisionActor(<ActorType> actor) IsCollisionFigure Query whether this actor is a collision figure in this simulation. A value of 1 indicates that it is a collision figure, and a value of 0 indicates that it is not a collision figure. Specify the name of the actor. <IntType> IsCollisionFigure(<FigureType> figure) Name Get the name of the simulation. none <StringType> Name() RemoveClothActor Remove a clothified actor from this simulation. Specify the name of the actor to remove. <NoneType> RemoveClothActor(<ActorType> actor) RemoveCollisionActor Remove this actor as a collision object from this simulation. Specify the name of the actor to remove. <NoneType> RemoveCollisionActor(<ActorType> actor) RemoveCollisionFigure Remove this figure as a collision object from this simulation. Specify the name of the figure to remove. <NoneType> RemoveCollisionFigure(<FigureType> figure) SetCurrentClothActor Set the current cloth actor. Specify the actor. <NoneType> SetCurrentClothActor(<ActorType> Actor) SetDrapingFrames Set the number of draping frames in this simulation.
120

Arguments Syntax Method Name Explanation Arguments Syntax Specify the number of frames.
<NoneType> SetDrapingFrames(<IntType> frames) SetDynamicsProperty Set the value of a named property. Specify the property name and value. <NoneType> SetDynamicsProperty(<StringType> Name, <FloatType> Value) SetEndFrame Set the end frame of this simulation. Enter the frame number. <NoneType> SetEndFrame(<IntType> frame) SetName Set the name of the simulation. Enter the desired name. <StringType> Name(<StringType> name) SetStartFrame Set the starting frame of this simulation. Enter the frame number. <NoneType> SetStartFrame(<IntType> frame) StartFrame Get the starting frame of this simulation. none <IntType> StartFrame()
Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax
DIALOGSIMPLE METHODS
Method Name Explanation Arguments Syntax Method Name Explanation <NoneType> AskActor(<StringType> message) AskFloat Ask the user for a floating-point number. AskActor Ask the user to select an actor.
121

Arguments Syntax Method Name Explanation Arguments Syntax Method Name Explanation Arguments Syntax Enter the request message.
<FloatType> AskFloat(<StringType> message) AskInt Ask the user for an integer value. Enter the request message. <FloatType> AskInt(<StringType> message) AskMenu Ask the user to select an item in a menu. Enter the menu title, the request message, and each of the subsequent items in the menu. <StringType> AskMenu(<StringType> title, <StringType> message, <StringType> item1, <StringType> item2, ...) MessageBox Show a message box with the message and an OK button. Enter the message. <NoneType> MessageBox(<StringType> message) PickImage Bring up the Texture Manager and let the user pick an image for this input. Specify the input to which the new image node will be attached. <NoneType> PickImage(<ShaderNodeInputType> inputInput) YesNo Show a dialog with the message and a Yes and a No button. The function returns 1 if the user clicks Yes, and 0 if the user clicks No. Enter the message. <IntType> YesNo(<StringType> message)
122

PoserPython Methods

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

PoserPython Methods

Hochgeladen von

Copyright:

Verfügbare Formate

PoserPython Methods Manual

for Windows and Mac OS X

TRADEMARK & COPYRIGHT NOTICE

Poser 6 - PoserPython Methods Manual

PoserPython Types & Methods Listing............................................................. 3

Poser 6 - PoserPython Methods Manual

Running PoserPython Scripts

1 RUNNING POSERPYTHON SCRIPTS

THE PYTHON SCRIPTS PALETTE

USING THE SCRIPT BUTTONS

ASSIGNING BUTTONS WITHIN THE CONSOLE

Poser 6 - PoserPython Methods Manual

Running PoserPython Scripts

EDITING SCRIPTS WITHIN THE CONSOLE

UNASSIGNING/REASSIGNING BUTTONS WITHIN THE CONSOLE

RUNNING PYTHON SCRIPTS DIRECTLY

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

2 POSERPYTHON TYPES & METHODS LISTING

Poser 6 - PoserPython Methods Manual Type

Types & Methods Listing

CLOTH SIMULATOR CODES

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

FIREFLY OPTIONS CODES

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

The above example sets the value of the FirstFrame option to 2.

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

SCENE CODES (RENDER ENGINES)

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

SHADER NODE CODES

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

Poser 6 - PoserPython Methods Manual

Types & Methods Listing

SHADER NODE INPUT CODES

Poser 6 - PoserPython Methods Manual

Types & Methods Listing