April 28, 2016

Trademark and Copyright Notice

Poser, the Poser logo, PoserFusion and the Smith Micro Logo are trademarks and or
registered trademarks of Smith Micro Software, Inc. Poser copyright © 1991-2012 All
Rights Reserved. All other product names are trademarks or registered trademarks of
their respective holders . Licensed product.

Please visit http://poser.smithmicro.com for updates and changes

to this manual.”
Contents
Trademark and Copyright Notice 2
Chapter 1: PoserPython Concepts  1
How Python Integrates with Poser 1
Basic Python Structure 3
Sample Python Script 3
Writing Python Scripts 4
wxPython4
Folder Syntax 4
Running Your Script 4
The Addon Menu 5
For Further Information 5
Chapter 2: PoserPython Types & Methods Listing 6
Types6
Codes7
Cloth Simulator Codes 7
COLLADA Codes 9
Dialog Codes 10
Display Codes 11
Firefly Options Codes 12
Import/Export Codes 13
Language Codes 16
Light Codes 16
Metadata Codes 17
Palette Codes 19
Parameter Codes 20
Room Codes 23
Scene Codes (Image Output Compression) 24
Shader Node Codes 25
Shader Node Input Codes 29
Callback Codes 30
ValueOp Codes 31
Falloff Zone Codes 31
Methods33
General Methods 33
Scene Methods 47
MovieMaker Methods 85
Importer/Exporter Methods 94
Actor Methods 99
Figure Methods 133
Material Methods 148
Material Layer Methods 159
Parameter Methods 160
ValueOp Methods 171
Geometry Methods 174
Texture Methods 180
Vertex Methods 181
Polygon Methods 182
TexPolygon Methods 185
TexVertex Methods 185
Skin Types 186
Shader Tree Methods 187
Shader Node Methods 189
Shader Node Input Methods 194
FireFly Options Methods 198
SuperFly Options Methods 217
Hair Methods 229
Cloth Simulator Methods 240
Shader Node Output Methods 245
DialogSimple Methods 246
Dialog Methods 247
DialogFileChooser Methods 248
DialogDirChooser Methods 249
DialogTextEntry Methods 250
CredManager Methods 250
1 Poser 11
PoserPython Methods Manual

Chapter 1: PoserPython
Concepts
This section describes some of PoserPython’s basic concepts in order to provide
context.

How Python Integrates with Poser

There are two basic types of programming languages:

• Compiled: A special program called a compiler reads the code written by the
programmer, translates it into a form directly readable by a computer, and
creates an executable program that can run on its own on any supported
computer platform. Languages such as C++ fit into this category.

• Interpreted: Interpreted programming languages require a special program

called an interpreter to run the code written by the programmer. The interpreter
reads the commands found in the code and executes them from beginning
to end without translating the original code. The drawback to interpreted
languages is that they must use the interpreter, and the code can never run as
a standalone program. The advantage, however, is that a programmer can
change the code and see the results very quickly without having to wait for the
code to compile. Additions, edits, and deletions become fast and simple.
PoserPython consists of a standard Python interpreter that has been extended to
recognize and execute commands that are not included with the standard Python
language. PoserPython scripts written using the customized commands will only
work with the Poser ProPack or subsequent versions (5 and on). You can, however,
pass data back and forth between Poser and other Python scripts, programming
languages, and applications.
The standard Poser application contains volumes of data about each item (figure,
scene, light, camera, prop, etc.) found within a given scene. You control these
parameters via the mouse and interface elements such as menus, buttons, dials,
etc. However, you cannot directly manipulate the data itself. This helps make Poser
easy to use, but does create limitations. For example, you have no way to automate
repetitive tasks or record a complex series of actions for further use. PoserPython
circumvents these limitations.
PoserPython exposes much of the raw Poser data. Using Python scripts, you can
extract data from Poser, manipulate it, and pass it back into Poser. Essentially, you
can program Poser to do what you want, and you are no longer confined to the
Poser interface and Poser’s built-in functionality.

Python scripts are add-ons to Poser, and are supposed to be

installed into the application installation folder (ex: C:\Program
Files (x86)\Smith Micro\Poser Pro 2012 for Windows, and
Applications: Poser Pro 2012 for Macintosh systems.


2 Poser 11
PoserPython Methods Manual

PYC creation is disabled by default. To enable it, open the Poser.

ini file and change ALLOW_PYTHON_PYC 0 to ALLOW_PYTHON_PYC 1.


3 Poser 11
PoserPython Methods Manual

Basic Python Structure

Python is an object-oriented language. An object is a virtual entity combining
structured data and the methods in which the data can be manipulated. A method
is a procedure for manipulating data, and an argument defines how the method is
carried out. A simplistic but effective analogy is that of basic grammar: An object
can be equated with a noun, a method with a verb, and an argument with an
adjective or adverb. For example, consider the following:
car = Factory.Produce(vehicleXL)
In this case, the variable car is the result of the object factory being acted upon
by the method produce as modified by the argument vehicleXL (the make and
model). To put it in lay terms, the car’s existence and everything about the car
depends on the factory being told to produce a car of a specified make and
model. Consider how the value of the variable car can differ based on the following
examples:
car = Mechanic.Repair(car, transmission)
car = Junkyard.Salvage(vehicleXL)
car = CarThief.Steal()
In the first example the car argument is passed in, modified by the Mechanic’s
Repair method, and returned as a working car. The last example contains no
argument. In this case, the car thief may not take external input to decide which car
to steal. Again, the object defines a structured set of data, the method is what the
object does, and any arguments describe how the method is performed.
The data can be virtually anything including letters, numbers, files, etc. As you begin
to think of data in terms of objects and manipulating objects, you will find it far easier
and faster to write Python scripts.

Sample Python Script

This section provides a brief example of how a Python script might look. For this
example, let’s say that you have an open Poser scene consisting of a figure with
its left forearm already selected. The forearm is called an actor. An actor is any
element of a Poser scene (body part, prop, etc.) and this manual uses the two terms
interchangeably. Let’s say you want to set the x scale to 88 percent.
scene = Poser.Scene()
actor = Scene.CurrentActor()
parm = actor.ParameterByCode(Poser.ParmCodeXSCALE)
parm.SetValue(88)
Let’s look at the above script in detail:
The script begins by obtaining a variable called scene, which is a reference to the
current Poser scene. That scene contains numerous actors. Recall that the left
forearm is already selected, so all the script needs to do is request the scene’s
current actor to define the variable actor. Next, the variable parm consists of a
reference to the left forearm’s specified parameter, in this case the parameter
XSCALE. A parameter code (ParmCode) designates an easy to remember word to
signify the desired parameter. Lastly, the value of the parameter to which parm refers
is reset to 88, which will cause the left forearm to shrink to 88% of its normal size along
the X-axis.


4 Poser 11
PoserPython Methods Manual

Writing Python Scripts

Write your Python scripts using your favorite text editor.

Poser expects strings to be encoded in Unicode. Scripts utilizing

non-Unicode string methods might not work properly.

Avoid multithreading, most especially operations that call the

PoserPython API from secondary threads.

wxPython
wxPython allows you to create add-ons that integrate very well with Poser. You can
also add your own palettes to the Poser GUI.
Refer to Runtime:Python:poserScripts: ScriptsMenu:Python Shell.py for implementation
basics.
The most important rule: Retrieve managed window from Poser, don’t create your
own main event loop.

Folder Syntax
Python, among other languages, designates certain special characters as symbols
beginning with a Windows-style backslash. Two common examples are \t ([TAB])
and \n (new line). Thus, in Windows, the notation
C:\folder\test.txt
is interpreted by Python as

C:[TAB]folder[TAB]text.txt or C: folder
test.txt
To work around this issue, you should use a double backslash (\\) to signify folders.
The above example would then become:
C:\\folder\\test.txt
which would be properly interpreted to mean a specific file path.
Alternatively, you can use Macintosh format, which uses colons to signify folders as
follows:
:folder:test.txt

Running Your Script

You can run your script directly or via the Poser Scripts menu or palette, all of which
are described in the following chapter.


5 Poser 11
PoserPython Methods Manual

The Addon Menu

The Window > Addon menu command is provided to allow for the addition of scripts
by third-party developers. Developers can find base classes and example add-ons in
the Runtime/Python/addons folder.

For Further Information

The preceding information was a very brief glimpse into Python and the PoserPython
extensions. If you do not currently know Python, you may want to read and learn
more. With the power and flexibility this interface offers, developing Python expertise
would be well worth it.
To view the Poser Python Methods Manual, choose Help >PoserPython Manual from
the menu commands.


6 Poser 11
PoserPython Methods Manual

Chapter 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 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:
ActorType 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.
AnimSetType An animation set
ClothSimulatorType ClothSimulator data
DictType An option dictionary
FigureType A figure within a scene
FireFlyOptionsType FireFly renderer options data
FunctionType Pointer to a callback function
GeomType Geometry forming part of a figure or prop
HairType Hair data
ImExporterType Importer/Exporter data
InputType A node input
MaterialType Material data
MovieMakerType MovieMaker data
ParmType A parameter (such as scale, twist, bend, etc.)
PolygonType Polygons (geometry surface faces)
SceneType A Poser scene
ShaderNodeInputType Shader Node Input data
ShaderNodeType Shader Node data
ShaderTreeType A ShaderTree
TexPolygonType Texture polygon data
TexVertType Texture vertices data
TupleType A Tuple
VertType Vertices (points defining the edges of polygons)
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.


7 Poser 11
PoserPython Methods Manual

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
Poser’s 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 scene’s 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 Reference Manual, “Chapter 29: The Cloth Room” for more
information about Cloth Simulators.

kClothParmCodeAIRDAMPING
The Air Damping parameter specifies the cloth’s 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 object’s 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 cloth’s resistance to in-plane

Cloth Simulator Codes

8 Poser 11
PoserPython Methods Manual

shearing, or side-to-side bending.

kClothParmCodeSPRINGRESISTANCE
The Spring Resistance parameter specifies the cloth’s 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 cloth’s 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 cloth’s 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 coordin ate axis.

kClothParmCodeVSTRETCHRESISTANCE
The Stretch Resistance parameter specifies the cloth’s resistance to in-plane
bending (stretching). The VStretchResistance code specifies the V coordinate
axis of the Stretch Resistance parameter.

Cloth Simulator Codes

9 Poser 11
PoserPython Methods Manual

COLLADA Codes
kExOptCodeCOLLADABakeDiffuseMap
Blend diffuse texture with diffuse color. If you enable this option Poser will write a
new texture map that is shader baked into a texture map

kExOptCodeCOLLADABakeTranparencyMap
Enable this option when your target application expects transparency
information in the alpha channel of the diffuse texture rather than as a separate
transparency map. You will be allowed to designate a channel name, and
choose whether or not you want to invert the transparency map (turn black to
white and vice versa).

kExOptCodeCOLLADAConformEveryFrame
This option forces a keyframe to be written for every frame of animation that
involves conforming figures. This can help improve visual fidelity, as the importing
app might not calculate conforming figures the same way as Poser does.

kExOptCodeCOLLADACustomUnitName
Specifies the name of the custom unit used with
kExOptCodeCOLLADAIsCustomUnit.

kExOptCodeCOLLADAExportTriangles
Exports triangulation of polygons upon export.

kExOptCodeCOLLADAFreezeFigMesh
Turns skinned figures into static props. Should be in the reference manual as well
(Include rigging or something along those lines).

kExOptCodeCOLLADAImportAnimation
.

kExOptCodeCOLLADAIncludeNormals
Allows you to specify whether polygon normals are exported explicitly.
Discarding the normals will require the target application to recompute them.
Toggling this option may help resolve shading issues.

kExOptCodeCOLLADAIsCustomUnit
Specifies whether a custom unit is being used during export.

kExOptCodeCOLLADALimitTextureSize
Specifies that the texture size will be limited to a maximum value.

kExOptCodeCOLLADAMaxTextureSize
Specifies the maximum value to which the texture output will be exported when
kExOptCodeCOLLADALimitTextureSize is enabled.

kExOptCodeCOLLADAMorphOption
Allows the export of morph targets so you get the essence of the morphs
without the file size and resource expense. You will not be able to animate the

COLLADA Codes
10 Poser 11
PoserPython Methods Manual

morph targets any more, but you will receive the same end result if you are only
interested in a particular shape variation that was present in your scene upon
export.

kExOptCodeCOLLADAPercentageScale
Allows the adjustment of the scale of a scene upon export. Adjust the scale if you
want to adjust the size of the scene.

kExOptCodeCOLLADAPoserUnitScaleCustom
Specifies the custom unit scale, in meters.

kExOptCodeCOLLADAPoserUnitScaleFactorType
Scale factor for the entire scene.

kExOptCodeCOLLADAPresetName
Specifies the preset used for standard units.

kExOptCodeCOLLADATexureSizePowerof2
Automatically resizes your texture to the nearest width and height that is a power
of 2. For example, a 1100 x 600 pixel image will be exported at a size of 1024 x
512. The original texture remains unaffected.

kExOptCodeCOLLADATranparencyMap
Creates a texture map that has transparency information baked in.

kExOptCodeCOLLADATransparentTypeRGB
When transparency is baked to a channel, specifies RGB

kExOptCodeCOLLADAUpAxis
Indicates which orientation the coordinate system has (Y-Up in Poser’s case).

kExOptCodeCOLLADAUseCultureInvariantName
.

kImOptCodeCOLLADAImportCameras
Adds cameras from imported COLLADA file.

kImOptCodeCOLLADAImportLights
Adds lights from imported COLLADA file.

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.

Dialog Codes
11 Poser 11
PoserPython Methods Manual

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.

kDisplayCodeTEXTURELINED
Texture Lined display mode.

kDisplayCodeTEXTURESHADED
Texture Shaded display mode.

KDisplayCodeUSEPARENTSTYLE
The style of the actor/figure’s parent.

KDisplayCodeWIREFRAME
Wireframe display mode.

Display Codes
12 Poser 11
PoserPython Methods Manual

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.

kOutlineCodeMEDIUMMARKER
Specifies the Medium Marker toon outline style.

kOutlineCodeMEDIUMPEN
Specifies the Medium Pen toon outline style.

kOutlineCodeMEDIUMPENCIL
Specifies the Medium Pencil toon outline style.

kOutlineCodeTHICKMARKER
Specifies the Thick Marker toon outline style.

kOutlineCodeTHICKPEN
Specifies the Thick Pen toon outline style.

kOutlineCodeTHICKPENCIL
Specifies the Thick Pencil toon outline style.

kOutlineCodeTHINMARKER
Specifies the Thin Marker toon outline style.

kOutlineCodeTHINPEN
Specifies the Thin Pen toon outline style.

kOutlineCodeTHINPENCIL
Specifies the Thin Pencil toon outline style.

kPixelFilterCodeBOX
Box Post Filter Type

kPixelFilterCodeGAUSS
Gaussian Post Filter Type

kPixelFilterCodeSINC
Sinc Post Filter Type

kRayAcceleratorCodeDEFAULT
Selects the default ray accelerator (currently Embree)

kRayAcceleratorCodeEMBREE
Selects the Embree ray accelerator

KRayAcceleratorCodeHBVO
Selects the HBVO ray accelerator.

Firefly Options Codes

13 Poser 11
PoserPython Methods Manual

KRayAcceleratorCodeKDTREE
Selects the kd tree ray accelerator.

KRayAcceleratorCodeVOXEL
Selects the Voxel ray accelerator.

kRenderEngineCodeFIREFLY
Selects Firefly renderer.

kRenderEngineCodePREVIEW
Selects Preview renderer.

kRenderEngineCodeSKETCH
Selects Sketch renderer.

kRenderEngineCodeSUPERFLY
Selects SuperFly renderer.

KTextureCompressorCodeRLE
Selects the Run-Length Encoding (RLE) format for texture compression.

KTextureCompressorCodeZIP
Selects the ZIP format for texture compression.

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 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).
Codes such as poser.kExOptCodeMULTIFRAME are pre-defined constants with
unique identifying values. For instance,
poser.kImOptCodeCENTERED = 0
poser.kImOptCodePLACEONFLOOR = 1
poser.kImOptCodePERCENTFIGSIZE = 2
poser.kImOptCodeOFFSETX = 3
poser.kImOptCodeOFFSETY = 4
etc.
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.

Import/Export Codes
14 Poser 11
PoserPython Methods Manual

kExOptCodeASMORPHTARGET
Saves current figure/prop as a morph target.

kExOptCodeAUTOSCALE
Set automatic scaling for BVH export.

kExOptCodeBODYPARTNAMESINPOLYGROUPS
Embed body part names in polygon groups.

kExOptCodeBROADCASTKEY
Viewpoint broadcast key.

kExOptCodeEXISTINGGROUPSINPOLYGROUPS
Keep existing polygon group names.

kExOptCodeFIGNAMESINGROUPS
Keep figure names in groups.

kExOptCodeFIRSTFRAME
First frame of export.

kExOptCodeGENERATEHTML
Viewpoint option generate HTML file with MTS/MTL.

kExOptCodeGEOMQUALITY
Viewpoint export geometry quality.

kExOptCodeGROUPSPERBODYPART
Keep body part groups.

kExOptCodeHTMLVIEWPORTHEIGHT
Viewpoint option HTML window height.

kExOptCodeHTMLVIEWPORTWIDTH
Viewpoint option HTML window width.

kExOptCodeIGNORECAMERAANIM
Viewpoint export ignores camera motions.

kExOptCodeIMAGEQUALITY
Viewpoint export image quality.

kExOptCodeLASTFRAME
Last frame of export

kExOptCodeMULTIFRAME
Multiple frame export.

Import/Export Codes
15 Poser 11
PoserPython Methods Manual

kExOptCodePERCENTSCALE

kExOptCodeSAVECOMPRESSED
Save files in compressed format.

kExOptCodeSCALEFACTOR
Scale exported scene by this amount.

kExOptCodeSOFTEDGESINHTML
Viewpoint export soft HTML window edges

kExOptCodeUSEANIMSETS
Viewpoint export use animation sets.

kExOptCodeUSEINTERNALNAMES
Use internal names.

kExOptCodeUSEWAVELETTEXTURES
Viewpoint option use wavelet textures.

kExOptCodeWELDSEAMS
Welds seams in figures/props.

kHiderREYES
Selects the REYES hider.

kHiderRayTrace
Selects the raytracing hider.

kImOptCodeARMALIGNMENTAXIS
Arm alignment axis

kImOptCodeAUTOSCALE
Automatic scaling

kImOptCodeCENTERED
Center object

kImOptCodeFLIPNORMS
Flip normals.

kImOptCodeFLIPUTEXTCOORDS
Flip U texture coordinates.

kImOptCodeFLIPVTEXTCOORDS
Flip V texture coordinates.

Import/Export Codes
16 Poser 11
PoserPython Methods Manual

kImOptCodeMAKEPOLYNORMSCONSISTENT
Make polygon normals consistent.

kImOptCodeOFFSETX
X offset amount.

kImOptCodeOFFSETY
Y offset amount.

kImOptCodeOFFSETZ
Z offset amount.

kImOptCodePERCENTFIGSIZE
Figure scale in percent

kImOptCodePLACEONFLOOR
Place object on floor

kImOptCodeSCALEABSOLUTE

kImOptCodeWELDIDENTICALVERTS
Weld identical vertices.

Language Codes
Language codes are codes representing the various languages for which this copy
of Poser may be localized.

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)

kLanguageCodeUSENGLISH
Sets US English as the default language.

Light Codes
These codes are used to set the light types. They are typically used in conjunction
with the actor.SetLightType() method.

kLightCodeAREA
Area ight.

Language Codes
17 Poser 11
PoserPython Methods Manual

kLightCodeIMAGE
Image Based light.

kLightCodeINFINITE
Infinite light.

kLightCodeINVLINEARATTEN
Sets Light Attenuation to Inverse Linear

kLightCodeINVSQUAREATTEN
Sets Light Attenuation to Inverse Square

kLightCodeLOCAL
Local light.

kLightCodePOINT
Point light.

kLightCodePOSERATTEN
Sets Light Attenuation to Poser default (Constant)

kLightCodeSPOT
Spotlight.

Metadata Codes
kMetadataProperty_dc_audience
Returns audience value from content metadata file.

kMetadataProperty_dc_contributor
Returns contributor value from content metadata file.

kMetadataProperty_dc_created
Returns created value from content metadata file.

kMetadataProperty_dc_creator
Returns creator value from content metadata file.

kMetadataProperty_dc_description
Returns description value from content metadata file.

kMetadataProperty_dc_format
Returns format value from content metadata file.

kMetadataProperty_dc_hasPart
Returns part value from content metadata file.

Metadata Codes
18 Poser 11
PoserPython Methods Manual

kMetadataProperty_dc_hasVersion
Returns version number value from content metadata file.

kMetadataProperty_dc_identifier
Returns identifier value from content metadata file.

kMetadataProperty_dc_instructionalMethod
Returns instructional method value from content metadata file.

kMetadataProperty_dc_isPartOf
Returns is part of value from content metadata file.

kMetadataProperty_dc_isRequiredBy
Returns is required by value from content metadata file.

kMetadataProperty_dc_publisher
Returns publisher value from content metadata file.

kMetadataProperty_dc_relation
Returns relation value from content metadata file.

kMetadataProperty_dc_requires
Returns requires value from content metadata file.

kMetadataProperty_dc_rights
Returns rights value from content metadata file.

kMetadataProperty_dc_rightsholder
Returns rightsholder value from content metadata file.

kMetadataProperty_dc_subject
Returns subject value from content metadata file.

kMetadataProperty_dc_title
Returns title value from content metadata file.

kMetadataProperty_dc_type
Returns type value from content metadata file.

kMetadataProperty_poser_characteristic
Returns Poser characteristic value from content metadata file.

kMetadataProperty_poser_combinedFileSize
Returns combined file size value from content metadata file.

kMetadataProperty_poser_conforming
Returns conforming value from content metadata file.

Metadata Codes
19 Poser 11
PoserPython Methods Manual

kMetadataProperty_poser_contentCategory
Returns content category value from content metadata file.

kMetadataProperty_poser_dependency
Returns dependency value from content metadata file.

kMetadataProperty_poser_ethnicity
Returns ethnicity value from content metadata file.

kMetadataProperty_poser_FigureCanon
Returns figure canon value from content metadata file.

kMetadataProperty_poser_fileSignature
Returns file signature value from content metadata file.

kMetadataProperty_poser_FrameCount
Returns frame count value from content metadata file.

kMetadataProperty_poser_gender
Returns gender value from content metadata file.

kMetadataProperty_poser_RenderSettings
Returns render settings value from content metadata file.

Palette Codes
These codes are used to specify specific palettes within Poser.

kCmdCodeAPPLYBULGES
Enables the Apply Bulges checkbox on the Joint Editor. Note: This constant is not
officially supported by Smith Micro Software, and we make no guarantees as to
its functionality or future availability.

kCmdCodeANIMATIONPALETTE
Returns the Animation palette.

kCmdCodeGROUPPALETTE
Returns the Group Editor palette.

kCmdCodeJOINTPALETTE
Returns the Joint Editor palette.

kCmdCodeLIBRARYPALETTE
Returns the Library palette.

kCmdCodeLIBRARYPALETTEFIGURES
Returns the Library palette, open to the Figures category. Note: This constant is
not officially supported by Smith Micro Software, and we make no guarantees as
to its functionality or future availability.

Palette Codes
20 Poser 11
PoserPython Methods Manual

kCmdCodePANDPPALETTE
Returns the Parameters and Properties palette.

kCmdCodeWALKPALETTE
Returns the Walk Designer.

kCmdCodeZEROFIGURE
Sends the Zero Figure command to the Joint Editor; returns the figure to its
original neutral pose. Note: This constant is not officially supported by Smith Micro
Software, and we make no guarantees as to its functionality or future availability.

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.

kParmCodeASCALE
Uniform scale parameter.

kParmCodeCENTER
For internal Poser use only.

KParmCodeCLOTHDYNAMICS
Dynamic cloth simulation parameter.

kParmCodeCURVE
Strength of bend deformation for an object using curve deformation.

kParmCodeDEFORMERPROP
Deformer prop channel.

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.

kParmCodeDYNAMICPARENT

kParmCodeFOCAL
Camera focal length parameter.

kParmCodeFOCUSDISTANCE
Camera focus distance parameter (affects Depth of Field effect).

Parameter Codes
21 Poser 11
PoserPython Methods Manual

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.

KParmCodeHAIRDYNAMICS
Dynamic hair simulation parameter.

kParmCodeHITHER
Camera parameter specifying a near clipping plane distance.

kParmCodeKDBLUE
Blue component of the diffuse color.

kParmCodeKDGREEN
Green component of the diffuse color.

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 light’s falloff zone.

kParmCodeLITEFALLOFFSTART
Starting distance for a light’s 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.)

Parameter Codes
22 Poser 11
PoserPython Methods Manual

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.)

kParmCodeSOFTDYNAMICS
Soft dynamics parameter.

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.

kParmCodeTARGET
Parameter controlling a morph target.

kParmCodeTGRASP
Hand’s 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 object’s amplitude parameter.

kParmCodeWAVEAMPLITUDENOISE
Wave object’s amplitude noise parameter.

kParmCodeWAVEFREQUENCY
Wave object’s frequency parameter.

kParmCodeWAVELENGTH
Wave object’s wavelength parameter.

kParmCodeWAVEOFFSET
Wave object’s offset parameter.

kParmCodeWAVEPHASE
Wave object’s phase parameter.

Parameter Codes
23 Poser 11
PoserPython Methods Manual

kParmCodeWAVESINUSOIDAL
Wave object’s sinusoidal form parameter.

kParmCodeWAVESQUARE
Wave object’s square form parameter.

kParmCodeWAVESTRETCH
Wave object’s stretch parameter.

kParmCodeWAVETRIANGULAR
Wave object’s triangular form parameter.

kParmCodeWAVETURBULENCE
Wave object’s 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.

Room Codes
The following codes specify individual rooms within Poser that can be called within
the PoserPython interface.

Room Codes
24 Poser 11
PoserPython Methods Manual

kCmdCodeCLOTHESROOM

KCmdCodeCLOTHROOM
Specifies the Cloth room.

KCmdCodeCONTENTROOM
Specifies the Content room.

KCmdCodeFACEOOM
Specifies the Face room.

kCmdCodeFITTINGROOM
Specifies the Fitting room.

KCmdCodeHAIRROOM
Specifies the Hair room.

KCmdCodeMATERIALROOM
Specifies the Material room.

KCmdCodePOSEROOM
Specifies the Pose room.

KCmdCodeSETUPROOM
Specifies the Setup room.

Scene Codes (Image Output Compression)

The following scene codes specify which image output compression will be used.

kTIFF_ADOBE_DEFLATE
Selects the Adobe DEFLATE image compression type for TIFF files.

kTIFF_DEFAULT
Selects the default TIFF image compression.

kTIFF_DEFLATE
Selects the DEFLATE image compression type for TIFF files.

kTIFF_JPEG
Selects the JPEG image compression type for TIFF files.

kTIFF_LZW
Selects the LZW image compression type for TIFF files.

kTIFF_NONE
Selects no image compression type for TIFF files.

Scene Codes (Image Output Compression)

25 Poser 11
PoserPython Methods Manual

kTIFF_PACKBITS
Selects the PACKBITS image compression type for TIFF files.

Shader Node Codes

These codes specify types of shader nodes. Please refer to the Poser 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
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.

kNodeTypeCodeCOMPOUND
Specifies a Compound node.

Shader Node Codes

26 Poser 11
PoserPython Methods Manual

kNodeTypeCodeCUSTOMSCATTER
Specifies a Custom Scatter 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.

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.

kNodeTypeCodeFRESNELBLEND
Specifies a Fresnel Blend lighting node.

kNodeTypeCodeGAMMA
Specifies a gamma adjustment node.

Shader Node Codes

27 Poser 11
PoserPython Methods Manual

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.

kNodeTypeCodeHSV
Specifies an HSV user defined color node.

kNodeTypeCodeHSV2
Specifies an HSV2 user defined color 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.

kNodeTypeCodeMICROFACET
Specifies a ks_microfacet node.

kNodeTypeCodeMOVIE
Specifies a Movie 2D texture node.

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.

Shader Node Codes

28 Poser 11
PoserPython Methods Manual

kNodeTypeCodePOSERSURFACE
Specifies the standard Poser surface root node.

kNodeTypeCodePROBELIGHT
Specifies a ProbeLight diffuse lighting node.

kNodeTypeCodeREFLECT
Specifies a Reflect raytrace lighting node.

kNodeTypeCodeREFRACT
Specifies a Refract raytrace lighting node.

kNodeTypeCodeSCATTER
Specifies a Scatter special node.

kNodeTypeCodeSCATTERSKIN
Specifies a Subsurface Skin special 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
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.

Shader Node Codes

29 Poser 11
PoserPython Methods Manual

kNodeTypeCodeV
Specifies a V Texture Coordinate variable node.

kNodeTypeCodeVELVET
Specifies a Velvet special lighting node.

kNodeTypeCodeVOLUME
Specifies a Volume 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.

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.

Shader Node Input Codes

30 Poser 11
PoserPython Methods Manual

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

kCBSceneChanged
not used

kCBValueChanged
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.

Callback Codes
31 Poser 11
PoserPython Methods Manual

kEventCodePARMCHANGED
Check to see if a parm has been changed.

kEventCodePARMDELETED
Check to see if a parm has been deleted.

kEventCodeSCENECLOSING
A function registered for this callback is being called when a scene is closing (for
example when the program is being closed or a new scene is opened). Scripts
can use this callback to clear their data structures or reset a GUI.

kEventCodeSETUPMODE
Check to see if Poser has been placed in Setup Room mode.

ValueOp Codes
The constants below name types of value operations that can be attached
to a parameter. The parameter then is either being set by a Python callback
(kValueOpTypeCodePYTHONCALLBACK) or is being combined with another
parameter through a mathematical operation (ERC) or a list of key/value pairs.
For a brief description of the value op codes, see “Value Operations (Poser Pro
Only)” on page 809 of your Poser Reference Manual.

kValueOpTypeCodeDELTAADD
kValueOpTypeCodeDIVIDEBY
kValueOpTypeCodeDIVIDEINTO
kValueOpTypeCodeKEY
kValueOpTypeCodeMINUS
kValueOpTypeCodePLUS
kValueOpTypeCodePYTHONCALLBACK
kValueOpTypeCodeTIMES

Falloff Zone Codes

The constant determines what kind of zone is created. WeightMap codes can
only be used in Poser Pro.

kZoneTypeCodeCAPSULE
Creates a Capsule Zone set to “multiply”. Its values may default to 0 or 1
depending on the parameter.

kZoneTypeCodeMERGEDWEIGHTMAP
(PRO ONLY) Merges all existing zone values into a new Weight Map Zone that is

ValueOp Codes
32 Poser 11
PoserPython Methods Manual

set to “replace”.

kZoneTypeCodeSPHERE
Creates a Sphere Zone set to “multiply”.

kZoneTypeCodeWEIGHTMAP
(PRO ONLY) Creates a weight map zone set to “multiply.”  Its values may default
to 0 or 1 depending on the parameter.

Falloff Zone Codes

33 Poser 11
PoserPython Methods Manual

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 method’s 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.

Please note that file paths differ between Mac and Windows
operating systems. A Mac path might appear as MyHardDisk:So
meFolder: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.

Path names in Poser-related library files and scripts use a colon

to separate the folders in the path (ie: Runtime:Libraries:charact
er:myfolder:myproduct.cr2). Using a colon in figure or group names
will cause potential problems when parsing PoserPython scripts, as
anything after the colon is ignored. Use of a colon in an actor name
(such as tail:1 or tail:9) is discouraged. Instead, name the item
something like tail01 or tail09.

General Methods

ActorType
Explanation

Arguments
None

General Methods
34 Poser 11
PoserPython Methods Manual

Syntax

AppLocation
Explanation
Query the file path location of the Poser application.
Arguments
None
Syntax
<StringType> AppLocation()

AppVersion
Explanation
Query the version of the Poser application.
Arguments
None
Syntax
<StringType> AppVersion()

Bitness
Explanation
Get the word size (32-bit or 64-bit) Poser was compiled for.
Arguments
None
Syntax
<StringType> Bitness()

ClearCommands
Explanation
Clear the command stack.
Arguments
None
Syntax
<NoneType> ClearCommand()

ClearTextureCache
Explanation
Empty the on-disk texture cache.
Arguments
None
Syntax
<NoneType> ClearTextureCache()

General Methods
35 Poser 11
PoserPython Methods Manual

CloseDocument
Explanation
Close the current Poser document. When set to a value other than zero, the
argument causes the method to discard any changes.
Arguments
Discard changes = 0 by default.
Syntax
<NoneType> CloseDocument({<IntType> discardChanges = 0})

CommandNames
Explanation
Returns a list of command names. The first name in the list is the oldest command
in the stack.
Arguments
None
Syntax
<List of StrType> CommandNames()

ContentRootLocation
Explanation
Query the file path location of the main Poser Runtime.
Arguments
None
Syntax
<StringType> ContentRootLocation()

CredManager
Explanation
Get a CredManager object. All methods needed to store and retrieve password
can be accessed from the returned object.
Arguments
None
Syntax
<CredManagerType> CredManager()

CurrentCommand
Explanation
Returns the current command index.
Arguments
None
Syntax
<IntType> CurrentCommand()

General Methods
36 Poser 11
PoserPython Methods Manual

CurrentRoom
Explanation
Return the id of the current room.
Arguments
None
Syntax
<IntType> CurrentRoom()

DefineMaterialWacroButton
Explanation
Attach a python script to one of 10 user defineable material wacro buttons. This
method is related to Wacro Setup.
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 Path: The file name and path of the script that the button will access.
• Label: How you wish to label the button.
Syntax
<NoneType> DefineMaterialWacroButton(<IntType> buttonIndex, <StringType>
filePath, <StringType> label)

DefineProjGuideHTMLWidget
Explanation
Load an HTML page to the Project Guide browser window.
Arguments
Enter the palette title you wish to display while the HTML file is showing, and the
file name and path of the HTML file. Takes label and file name as arguments.
Syntax
<NoneType> DefineProjGuideHTMLWidget(<StringType> title, <StringType>
filePath)

DefineProjGuideScriptButton
Explanation
Attach a python script to Go Backward/Go Forward Project Guide buttons.
Arguments
Enter the button index for the button you wish to assign, and the file name and
path of the script that the button will access. Takes index (Go Backward: 1, Go
Forward : 2), file name, and a label as arguments.
Syntax
<NoneType> DefineProjGuideScriptButton(<IntType> buttonIndex,
<StringType> filePath)

General Methods
37 Poser 11
PoserPython Methods Manual

DefineScriptButton
Explanation
Attach a python script to one of the 10 buttons on the Python Scripts palette.
Arguments
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
<NoneType> DefineScriptButton(<IntType> buttonIndex, <StringType>
filePath, <StringType> label)
Examples
poser.DefineScriptButton (1, “C:\Documents and Settings\<user>\My
Documents\Test Scripts\test.py”, “Test Script”)
poser.DefineScriptButton (1, “Macintosh HD/Users/<username>/Documents/
Test Scripts/test.py”, “Test Script”)

DialogSimple
Explanation
Provides methods for quick dialogs.
Arguments
None
Syntax
<StringType> DialogSimple()

EnableParallelComputeActors
Explanation
Set to enable actor computation in parallel
Arguments
Enter 0 to disable parallel actor computation, 1 to enable. Not officially
supported by Smith Micro Software, and we make no guarantees as to its
functionality or future availability.
Syntax
<NoneType> EnableParallelComputeActors(<BoolType> value)

EnableParallelHairCollision
Explanation
Set to enable hair collision calculations in parallel
Arguments
Enter 0 to disable hair collision, 1 to enable.
Syntax
<NoneType> EnableParallelHairCollision(<BoolType> value)

General Methods
38 Poser 11
PoserPython Methods Manual

EnableTriMeshPrecomputation
Explanation
Set to enable TriMesh precomputation (used in hair collision calculations).
Arguments
Enter 0 to disable TriMesh computation, 1 to enable.
Syntax
EnableTriMeshPrecomputation(<BoolType> value)

ExecFile
Explanation
Run a Python script using a Mac or Windows pathname.
Arguments
Enter the complete path of the script you wish to execute.
Syntax
<NoneType> ExecFile(<StringType> fileName)
Example
poser.ExecFile (“My Macintosh:Curious Labs:Poser 4:Runtime: Python:test.
py”)

FileMetadata
Explanation
Get a set of key/value metadata pairs for a Poser file.
Arguments

Syntax
<DictType> FileMetadata(<StringType> poserFilePath)
Example
alysonProperties = poser.FileMetadata (“C:\Users\Public\Documents\Poser
Pro 2012 Content\Runtime\Libraries\Character\People\Alyson\Alyson2.cr2”)

Flavor
Explanation
Return a string identifying the flavor of the running Poser application. e.g. Poser,
Poser Pro, or Poser Debut.
Arguments
None.
Syntax
<StringType> Flavor()

IsGameDev
Explanation
Return whether the Poser executable is the GameDev version.
Arguments
None.

General Methods
39 Poser 11
PoserPython Methods Manual

Syntax
<IntType> IsGameDev()

IsPro
Explanation
Return whether the Poser executable is the Pro version. Returns 1 for Pro, 0
otherwise.
Arguments
None.
Syntax
<IntType> Version()

Language
Explanation
Query the application’s language. The integer returned will match one of the
language codes explained above.
Arguments
None
Syntax
<IntType> Language()

LeakMemory
Explanation
Leak n bytes of memory
Arguments
None
Syntax
LeakMemory({<IntType> memory_size})

Libraries
Explanation
Query the file paths of the Libraries. Returns an array of the Library paths
Arguments
None
Syntax
<StringType> Libraries()

MainWindow
Explanation
Returns the Poser Shell.
Arguments
None

General Methods
40 Poser 11
PoserPython Methods Manual

Syntax
<StringType> MainWindow()

NewDocument
Explanation
Open the default Poser document
Arguments
None
Syntax
<NoneType> NewDocument()

NewGeometry
Explanation
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.
Arguments
None
Syntax
<GeomType> NewGeometry()

NewMotionRig
Explanation
Create a new motion rig. Not officially supported by Smith Micro Software, and
we make no guarantees as to its functionality or future availability.
Arguments
None
Syntax
<MotionRigType> NewMotionRig(<NoneType>)

NumRenderThreads
Explanation
Get the number of rendering threads.
Arguments
None
Syntax
<IntType> NumRenderThreads()

OpenDocument
Explanation
Open an existing Poser document (.pz3 file). Takes a file path (absolute or
relative to the Poser folder) as the argument.
Arguments
Enter either the complete or relative path to the Poser document you wish to

General Methods
41 Poser 11
PoserPython Methods Manual

open.
Syntax
<NoneType> OpenDocument(<StringType> filePath)
Example
poser.OpenDocument(“My Macintosh:Runtime:Scenes: myscene.pz3”)

PaletteById
Explanation
Returns a specific palette identified by the Poser palette constant (such as
kCmdCodeANIMATIONPALETTE).
Arguments
Enter the Poser palette identification constant.
Syntax
<PaletteType> PaletteById(<IntType> constant)

Palettes
Explanation
Returns a list of accessible palettes.
Arguments
None
Syntax
<ListType> Palettes()

PrefsLocation
Explanation
Get the Poser Prefs dir
Arguments
None
Syntax
<String> PrefsLocation()

PreviewRenderEngineType
Explanation
Get active preview render engine type. Returns either poser.
kPreviewRenderEngineTypeCodeOPENGL or poser.kPreviewRenderEngineType
CodeSREED.
Arguments
None
Syntax
<IntType> PreviewRenderEngineType()

General Methods
42 Poser 11
PoserPython Methods Manual

ProcessCommand
Explanation
Send a command to Poser
Arguments
Specify the ID of the command that should be processed.
Syntax
<NoneType> PoserCommand(<IntType>)

Quit
Explanation
Quit the Poser Application.
Arguments
Optional argument non-zero means discard any changes.
Syntax
<NoneType> Quit({<IntType> discardChanges = 0})

Redo
Explanation
Redoes one action.
Arguments
None
Syntax
<NoneType> Redo()

RegisterAddon
Explanation
Register a new addon module.
Arguments
Add the name of the addon.
Syntax
<NoneType> RegisterAddon(<StringType>addonName)

RenderInSeparateProcess
Explanation
Query whether FireFly is rendering in a separate process.
Arguments
None
Syntax
<IntType> RenderInSeparateProcess()

General Methods
43 Poser 11
PoserPython Methods Manual

RevertDocument
Explanation
Revert the current document to the last saved state.
Arguments
None
Syntax
<NoneType> RevertDocument()

Rooms
Explanation
Displays a list of the rooms accessible within Poser. You could then iterate
through this list, comparing against a Poser Room constant (such as
kCmdCodeHAIRROOM), until you found the matching room, and access the
specific room from the list in this way.
Arguments
None
Syntax
<ListType> Rooms()

SaveDocument
Explanation
Save an existing Poser document. Takes an optional file name as argument.
Arguments
Enter a valid path to save the file to that location/filename. If you do not specify
an argument, the file will be saved in its current path with its current name.
Syntax
<NoneType> SaveDocument({<StringType> filePath})
Example
poser.SaveDocument(“C:\My Documents\Poser Stuff\myscene2.pz3”)

SavePrefs
Explanation
Ask Poser to save the preferences of addon modules Call this after the
preferences of you addon were changed and you want to save them.
Arguments
None
Syntax
<NoneType> SavePrefs(<NoneType>)

Scene
Explanation
Return the current Poser scene as an object.
Arguments
None

General Methods
44 Poser 11
PoserPython Methods Manual

Syntax
<SceneType> Scene()

ScriptLocation
Explanation
Query the file path location of the current Python script.
Arguments
None
Syntax
<StringType> ScriptLocation()

SetCheckZeroMorphs
Explanation

Arguments

Syntax

SetCurrentRoom
Explanation
Set the current room of the UI via room id.
Arguments

Syntax
SetCurrentRoom(<IntType>)

SetFileMetadata
Explanation
Set a dictionary of key/value metadata pairs for a Poser file
Arguments
Specify the path of the file that metadata should be set for, and a dictionary
containing all properties to be set.
Syntax
<NoneType> SetFileMetadata(<StringType> poserFilePath, <DictType>
keyValuePairs)

SetLanguage
Explanation
Set the current language
Arguments

General Methods
45 Poser 11
PoserPython Methods Manual

Syntax
SetLanguage({<IntType> languageID})

SetNumRenderThreads
Explanation
Set the number of rendering threads
Arguments
Enter the number of rendering threads you wish to use.
Syntax
<NoneType> SetNumRenderThreads(<IntType> numThreads)

SetParallelComputeActorsThreadCount
Explanation
Number of threads to use for ParallelComputeActors computation
Arguments
Enter the number of threads you wish to use. (0=default=NumCPU’s)
Syntax
<NoneType> SetParallelComputeActorsThreadCount(<int> value)

SetParallelHairCollisionThreadCount
Explanation
Number of threads to use for ParallelHairCollision computation
Arguments
Enter the number of rendering threads you wish to use. (0=default=NumCPU’s*8)
Syntax
<NoneType> SetParallelHairCollisionThreadCount(<int> value)

SetPreviewRenderEngineType
Explanation
Set active preview render engine type.
Arguments
Render engine type can be either
poser.kPreviewRenderEngineTypeCodeOpenGL
or
poser.kPreviewRenderEngineTypeCodeSREED
Syntax
<NoneType> SetPreviewRenderEngineType(<IntType> renderEngineType)

SetRenderInSeparateProcess
Explanation
Set whether FireFly renders in a separate process. A value of 1 enables rendering
in a separate process; a value of 0 disables rendering in a separate process.

General Methods
46 Poser 11
PoserPython Methods Manual

Arguments
Enter a value of 1 or 0.
Syntax
<NoneType> SetRenderInSeparateProcess(<IntType> separateProcess)

SetWriteBinaryMorphs
Explanation
Set if Poser writes morph targets as binary files.
Arguments
Enter a value of 1 to enable external binary morph targets when adding to the
library or saving a scene.
Syntax
<NoneType> SetWriteBinaryMorphs(<IntType>binaryMorphs)

ShowFrameRate
Explanation
Enable or disable display of frame rate
Arguments
Enter a value of 1 to enable frame rate display, 0 to disable.
Syntax
<NoneType> ShowFrameRate(<BoolType> iOnOff)

StringResource
Explanation
Return the string resource for the given major and minor ID.
Arguments
Enter the major and minor ID.
Syntax
<StringType> StringResource(<IntType> majorID, <IntType> minorID)

TempLocation
Explanation
Get the Poser temporary files directory.
Arguments
None
Syntax
<String> TempLocation()

Undo
Explanation
Undoes one action.
Arguments
None

General Methods
47 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> Undo()

Version
Explanation
Return the version number for Poser.
Arguments
None
Syntax
<StringType> Version()

WriteBinaryMorphs
Explanation
Get if Poser writes morph targets as binary files.
Arguments
None
Syntax
<IntType> WriteBinaryMorphs()

WxApp
Explanation
Get the wxApp object of the Poser application.
Arguments
None
Syntax
<class ‘wx._core.App’> wxApp()

WxAuiManager
Explanation
Get the wxAuiManager of the Poser UI.
Arguments
None
Syntax
<class ‘wx.aui.AuiManager’>

Scene Methods

Actor
Explanation
Find a scene actor by its external name. This is the name seen in Poser GUI pull-
down menus (such as “Left Forearm”).

Scene Methods
48 Poser 11
PoserPython Methods Manual

Arguments
Enter the desired actor’s external name.
Syntax
<ActorType> Actor(<StringType> actorName)
Example
actor = scene.Actor(“Left Forearm”)

ActorByInternalName
Explanation
Finds the actor in the currently selected figure by its internal name. The argument
string is the unique identifier for the object kept internally by Poser.

The method gets the first actor matching the argument string
(for example, if the internal name is BODY:3, it returns BODY:1).
You cannot choose a particular actor in a specific figure without
choosing the figure first.

Arguments
Enter the actor’s internal name.
Syntax
<ActorType> ActorByInternalName(<StringType> internalName)
Example
actor = scene.ActorByInternalName(“lRing2”)

Actors
Explanation
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, which will be appended by the figure number to
indicate that they are a body part. To get a list of actors belonging to a figure,
use the Actors() method for a figure object.
Arguments
None
Syntax
<ActorType List> Actors()

AnimSet
Explanation
Return the specified animation set.
Arguments
Enter a valid animation set name.
Syntax
<AnimSetType> AnimSet(<StringType> AnimSetName)
Example
someAnimSet = scene.AnimSet(“MyNewAnimationSet”)

Scene Methods
49 Poser 11
PoserPython Methods Manual

AnimSets
Explanation
Return a list of all animation sets within the scene
Arguments
None
Syntax
<AnimSetType list> AnimSets()

AntialiasNow
Explanation
Draw the current display with anti-aliasing enabled.
Arguments
None
Syntax
<NoneType> AntialiasNow()

AtmosphereShaderTree
Explanation
Returns the ShaderTree for the atmosphere.
Arguments
None
Syntax
<ShaderTreeType> AtmosphereShaderTree()

BackgroundColor
Explanation
Return the RGB color in the range 0.0 to 1.0 that is being used for the background
display.
Arguments
None
Syntax
(<FloatType> R, <FloatType> G, <FloatType> B) BackgroundColor()

BackgroundImage
Explanation
Returns the name of the current background image, if any.
Arguments
None
Syntax
<StringType> BackgroundImage()

Scene Methods
50 Poser 11
PoserPython Methods Manual

BackgroundMovie
Explanation
Returns the name of the current background movie, if any.
Arguments
None
Syntax
<StringType> BackgroundMovie()

BackgroundShaderTree
Explanation
Returns the ShaderTree for the scene’s background.
Arguments
None
Syntax
<ShaderTreeType> BackgroundShaderTree()

Cameras
Explanation
Return a list of scene cameras. Note that cameras are a specific kind of actor.
Arguments
None
Syntax
<ActorType List> Cameras()

Changed
Explanation
Get whether the document has been changed since it was last saved.
Arguments
None
Syntax
<IntType> Changed()

ClearEventCallback
Explanation
Clear the per-event callback set with SetEventCallback()
Arguments
None
Syntax
<NoneType> ClearEventCallback()

Scene Methods
51 Poser 11
PoserPython Methods Manual

ClearSound
Explanation
Specifies that no sound file is to be associated with this Poser document.
Arguments
None
Syntax
<NoneType> ClearSound()

ClearStartupScript
Explanation
Specify that no Python script is to be associated with the current Poser document
and un-assign the currently associated startup script.
Arguments
None
Syntax
<NoneType> StartupScript()

ClearWorldspaceCallback
Explanation
Clear the per-update callback to process scene elements after the entire scene
has been processed to world space.
Arguments
None
Syntax
<NoneType> ClearWorldspaceCallback()

ClothSimulator
Explanation
Returns the ClothSimulator with the specified index.
Arguments
Specify the index of the desired ClothSimulator.
Syntax
<ClothSimulatorType> ClothSimulator(<IntType> Index)

ClothSimulatorByName
Explanation
Find a ClothSimulator object by its name.
Arguments
Specify the name of the ClothSimulator you wish to locate.
Syntax
<ClothSimulatorType> ClothSimulatorByName(<StringType> name)

Scene Methods
52 Poser 11
PoserPython Methods Manual

CopyToClipboard
Explanation
Copy the current display to the clipboard.
Arguments
None
Syntax
<NoneType> CopyToClipboard()

CreateAnimSet
Explanation
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.
Arguments
Enter your desired animation set name, ensuring there is not already an existing
animation set with the same name.
Syntax
<AnimSetType> CreateAnimSet(<StringType> AnimSetName)
Example
newAnimSet = scene.CreateAnimSet(“MyNewAnimationSet”)

CreateClothSimulator
Explanation
Create a new ClothSimulator object.
Arguments
Specify the name of the ClothSimulator object.
Syntax
<ClothSimulatorType> CreateClothSimulator(<StringType> name)

CreateGeomFromGroup
Explanation
Generate a new geometry object from a polygon group.
Arguments
Enter a valid group name from which the polygons will be obtained.
Syntax
<GeomType> CreateGeomFromGroup(<ActorType> actor, <StringType>
groupName)
Example
geom = scene.CreateGeomFromGroup(abdomen “Abdomen”)

CreateGrouping
Explanation
Create a grouping object.
Arguments
None

Scene Methods
53 Poser 11
PoserPython Methods Manual

Syntax
<ActorType> CreateGrouping()

CreateLight
Explanation
Create a new spotlight in the scene.
Arguments
None
Syntax
<ActorType> CreateLight()

CreateMagnet
Explanation
Create a magnet on the current actor.
Arguments
None
Syntax
<ActorType> CreateMagnet()

CreatePropFromGeom
Explanation
Create a new scene prop from a geometry.
Arguments
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
<ActorType> CreatePropFromGeom(<GeomType> geometry, <StringType>
propName)
Example
newProp = scene.CreatePropFromGeom(someActor.Geometry(), “ImaProp”)

CreateWave
Explanation
Create a wave deformer on the current actor.
Arguments
None
Syntax
<ActorType> CreateWave()

CurrentActor
Explanation
Get the currently selected actor.

Scene Methods
54 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<ActorType> CurrentActor()

CurrentCamera
Explanation
Get the current camera. Note that cameras are a specific kind of actor.
Arguments
None
Syntax
<ActorType> CurrentCamera()

CurrentFigure
Explanation
Get the currently selected figure.
Arguments
None
Syntax
<FigureType> CurrentFigure()

CurrentFireFlyOptions
Explanation
Returns the current FireFly options.
Arguments
None
Syntax
<FireFlyOptionsType> CurrentFireFlyOptions()

CurrentLight
Explanation
Get the current light. Note that lights are a specific kind of actor.
Arguments
None
Syntax
<ActorType> CurrentLight()

CurrentMaterial
Explanation
Returns the currently selected material. Returns None if no material is selected.
Arguments
None

Scene Methods
55 Poser 11
PoserPython Methods Manual

Syntax
<MaterialType> CurrentMaterial()

CurrentMaterialLayer
Explanation
Returns the currently selected material layer (typically the layer shown in the
Advanced view of the Material Room). Returns None if no material is selected.
Arguments
None
Syntax
<MaterialLayerType> CurrentMaterialLayer()

CurrentRenderEngine
Explanation
Get the current render engine.
Arguments
None
Syntax
<IntType> CurrentRenderEngine()

CurrentSuperFlyOptions
Explanation
Returns the current SuperFly options.
Arguments
None
Syntax
<SuperFlyOptionsType> CurrentSuperFlyOptions()

DeleteAnimSet
Explanation
Delete the specified animation set.
Arguments
Enter your desired animation set name.
Syntax
<NoneType> DeleteAnimSet(<StringType> AnimSetName)
Example
scene.DeleteAnimSet(“MyNewAnimationSet”)

DeleteCurrentFigure
Explanation
Delete the currently selected figure.
Arguments
None

Scene Methods
56 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> DeleteCurrentFigure()

DeleteCurrentProp
Explanation
Delete the currently selected prop.
Arguments
None
Syntax
<NoneType> DeleteCurrentProp()

DisplayStyle
Explanation
Get the document’s interactive display style. Typical return values correspond to
poser member variable constants (such as poser.kDisplayCodeWIREFRAME).
Arguments
None
Syntax
<IntType> DisplayStyle()

DocumentPath
Explanation
Returns the file system path of the current scene. Will return None when the
document has not been saved yet.
Arguments
None
Syntax
<StringType> DocumentPath()

Draw
Explanation
Redraw modified objects.
Arguments
None
Syntax
<NoneType> Draw()

DrawAll
Explanation
Redraw everything in the scene.
Arguments
None

Scene Methods
57 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> DrawAll()

Figure
Explanation
Get a figure, given its name. The argument is the external name in the Poser GUI
pull-down menus (such as “Figure 1”).
Arguments
Enter the figure’s name.
Syntax
<FigureType> Figure(<StringType> figureName)
Example
fig = scene.Figure(“Figure 1”)

FigureByInternalName
Explanation
Get a figure, given its internal name. The argument is the external name in the
Poser GUI pulldown menus (such as “Figure 1”).
Arguments
Enter the figure’s internal name.
Syntax
FigureByInternalName(<StringType> figureName

Figures
Explanation
Get a list of the figure objects in the scene. Figures are bodies composed of
actors in a hierarchy.
Arguments
None
Syntax
<FigureType list> Figures()

FireFlyOptions
Explanation
Returns the FireFly options with the specified index.
Arguments
Specify the index of the desired FireFly options.
Syntax
<FireFlyOptionsType> FireFlyOptions(<IntType> index)

FireFlyOptionsByName
Explanation
Finds FireFly options using a specified name.

Scene Methods
58 Poser 11
PoserPython Methods Manual

Arguments
Specify the name of the desired FireFly options.
Syntax
<FireFlyOptionsType> FireFlyOptionsByName(<StringType> name)

ForegroundColor
Explanation
Return the foreground RGB color in the range 0.0 to 1.0
Arguments
None
Syntax
(<FloatType> R, <FloatType> G, <FloatType> B) ForegroundColor()

Frame
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.
Arguments
None
Syntax
<IntType> Frame()

FrameSelected
Explanation
Frame and zoom current actor in center of scene.
Arguments
None
Syntax
<NoneType> FrameSelected()

FramesPerSecond
Explanation
Return the current frame rate.
Arguments
None
Syntax
<IntType> FramesPerSecond()

GeomFileName
Explanation
Returns the filename of the geometry being used by the current actor, if any.

Scene Methods
59 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<StringType> actor.GeomFileName()

GroundColor
Explanation
Return the ground RGB color in the range 0.0 to 1.0.
Arguments
None
Syntax
(<FloatType> R, <FloatType> G, <FloatType> B) GroundColor()

GroundShadows
Explanation
Get status of ground shadow display.
Arguments
None
Syntax
<NoneType> GroundShadows()

ImExporter
Explanation
Get the importer/exporter object to access importing and exporting of non-Poser
3D file formats.
Arguments
None
Syntax
<ImExporterType> ImExporter()

Lights
Explanation
Return a list of scene lights. Note that lights are a specific kind of actor.
Arguments
None
Syntax
<ActorType List> Lights()

LoadLibraryCamera
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.

Scene Methods
60 Poser 11
PoserPython Methods Manual

Arguments
Enter the complete path and file name.
Syntax
<NoneType> LoadLibraryCamera(<StringType> filePath)
Example
scene.LoadLibraryCamera(“Runtime\Libraries\ MyCamera.cm2”)

LoadLibraryFace
Explanation
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.
Arguments
Enter the complete path and file name.
Syntax
<NoneType> LoadLibraryFace(<StringType> filePath)
Example
scene.LoadLibraryFace(“\Runtime\Libraries\MyFace. fc2”)

LoadLibraryFigure
Explanation
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.
Arguments
Enter the complete path and file name. Optionally specify whether or not auto
grouping should be set up.
Syntax
<NoneType> LoadLibraryFigure(<StringType> filePath, {<IntType>
setupAutoGroup})
Example
scene.LoadLibraryFigure(“\Runtime\Libraries\MyFigure.cr2”)

LoadLibraryHair
Explanation
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.
Arguments
Enter the complete path and file name.
Syntax
<NoneType> LoadLibraryHair(<StringType> filePath)
Example
scene.LoadLibraryHair(“\Runtime\Libraries\MyHair.hr2”)

Scene Methods
61 Poser 11
PoserPython Methods Manual

LoadLibraryHand
Explanation
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.
Arguments
• Filename: Enter the complete path and file name.
• Left Hand: The second argument is optional and defaults to 0. A right hand is loaded by
default. Entering a value other than 0 will load the left hand.
Syntax
<NoneType> LoadLibraryHand(<StringType> filePath, {<IntType> leftHand =
0})
Example
scene.LoadLibraryHand(“\Runtime\Libraries\MyHands.hd2”, 1)

LoadLibraryLight
Explanation
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.
Arguments
Enter the complete path and file name.
Syntax
<NoneType> LoadLibraryLight(<StringType> filePath)
Example
scene.LoadLibraryLight(“\Runtime\Libraries\MyLight.lt2”)

LoadLibraryPose
Explanation
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.
Arguments
Enter the complete path and file name.
Syntax
<NoneType> LoadLibraryPose(<StringType> filePath)
Example
scene.LoadLibraryPose(“\Runtime\Libraries\MyPose.pz2”)

LoadLibraryProp
Explanation
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.
Arguments
Enter the complete path and file name.

Scene Methods
62 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> LoadLibraryProp(<StringType> filePath)
Example
scene.LoadLibraryProp(“\Runtime\Libraries\MyProp.pp2”)

Measurements
Explanation
Return a list of measurements. Note that measurements are a specific kind of
actor.
Arguments

Syntax
<ActorType List> Measurements()
Example
scene.LoadLibraryProp(“\Runtime\Libraries\MyProp.pp2”)

MemorizeAll
Explanation
Memorize Scene state
Arguments
None
Syntax
<NoneType> MemorizeAll()

MemorizeLights
Explanation
Memorize Lights
Arguments
None
Syntax
<NoneType> MemorizeLights()

MorphFiles
Explanation
Returns a list of the used morph target files.
Arguments
None
Syntax
<StringType list> MorphFiles()

MovieMaker
Explanation
Get a MovieMaker object to access animation specifics. All methods needed to

Scene Methods
63 Poser 11
PoserPython Methods Manual

output animated movies can be accessed from the returned object.

Arguments
None
Syntax
<MovieMakerType> MovieMaker()

NextKeyFrame
Explanation
Returns the frame number of the next key frame for the current actor.
Arguments
None
Syntax
<IntType> NextKeyFrame()

NextKeyFrameAll
Explanation
Returns the frame number of the next key frame in the current scene.
Arguments
None
Syntax
<IntType> NextKeyFrameAll()

NumBodyParts
Explanation
Return the number of body parts in the scene.
Arguments
None
Syntax
<IntType> NumBodyParts()

NumBumpMaps
Explanation
Return the number of bump-maps in the scene.
Arguments
None
Syntax
<IntType> NumBumpMaps()

NumCameras
Explanation
Return the number of cameras in the scene.
Arguments
None

Scene Methods
64 Poser 11
PoserPython Methods Manual

Syntax
<IntType> NumCameras()

NumClothSimulators
Explanation
Returns the number of ClothSimulators in the scene.
Arguments
None
Syntax
<IntType> NumClothSimulators()

NumFigures
Explanation
Return the number of figures in the scene.
Arguments
None
Syntax
<IntType> NumFigures()

NumFrames
Explanation
Return the number of frames of animation.
Arguments
None
Syntax
<IntType> NumFrames()

NumGeometries
Explanation
Return the number of geometries in the scene (equal to the number of props
[numProps] + plus the number of body parts [numBodyParts]).
Arguments
None
Syntax
<IntType> NumGeometries()

NumImageMaps
Explanation
Return the number of image-maps in the scene.
Arguments
None
Syntax
<IntType> NumImageMaps()

Scene Methods
65 Poser 11
PoserPython Methods Manual

NumLights
Explanation
Return the number of lights in the scene.
Arguments
None
Syntax
<IntType> NumLights()

NumProps
Explanation
Return the number of props in the scene.
Arguments
None
Syntax
<IntType> NumProps()

OutputRange
Explanation
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.
Arguments
None
Syntax
(<IntType> x, <IntType> y) OutputRange()

OutputRes
Explanation
Return a tuple containing the output image. The resolution consists of a
horizontal and a vertical number of pixels.
Arguments
None
Syntax
(<IntType> x, <IntType> y) OutputRes()

PmdDiff
Explanation
Difference between two PMD files.
Arguments
None
Syntax

Scene Methods
66 Poser 11
PoserPython Methods Manual

PrevKeyFrame
Explanation
Return the frame number of the previous key frame for the current actor.
Arguments
None
Syntax
<IntType> PrevKeyFrame()

PrevKeyFrameAll
Explanation
Return the frame number of the previous key frame in the scene.
Arguments
None
Syntax
<IntType> PrevKeyFrameAll()

ProcessSomeEvents
Explanation
Process the specified number of Poser events.
Arguments
Enter the number of events to process (integer value).
Syntax
<NoneType> ProcessSomeEvents({<IntType> numEvents = <argument>)
Example
ProcessSomeEvents(numEvents = 1)

Render
Explanation
Render to the current view.
Arguments
None
Syntax
<NoneType> Render()

RenderAntiAliased
Explanation
Query renderer’s 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.
Arguments
None
Syntax
<IntType> RenderAntiAliased()

Scene Methods
67 Poser 11
PoserPython Methods Manual

RenderBumpMaps
Explanation
Query the renderer’s 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.
Arguments
None
Syntax
<IntType> RenderBumpMaps()

RenderCastShadows
Explanation
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.
Arguments
None
Syntax
<NoneType> RenderCastShadows()

RenderDimAutoscale
Explanation
Get the current autoscale resolution setting. Choices are: 0 for Exact Size, 1 for Fit
to Preview and 2 for Match to Preview.
Arguments
None
Syntax
(<IntType> option) RenderDimAutoscale()

RenderIgnoreShaderTrees
Explanation
Query whether the render engine will ignore shader trees. A return value of 1
indicates that the option is on, while a value of 0 indicates that it is off.
Arguments
None
Syntax
<NoneType> RenderIgnoreShaderTrees()

RenderInBackground
Explanation
Starts a background render task.
Arguments
None
Syntax
<NoneType> RenderInBackground()

Scene Methods
68 Poser 11
PoserPython Methods Manual

RenderOnBGColor
Explanation
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.
Arguments
None
Syntax
<IntType> RenderOnBGColor()

RenderOnBGPict
Explanation
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.
Arguments
None
Syntax
<IntType> RenderOnBGPict()

RenderOnBlack
Explanation
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.
Arguments
None
Syntax
<IntType> RenderOnBlack()

RenderOverType
Explanation
Query render-over type. The return values are 0, 1, 2, and 3 for color, black, bg
pict (background picture), and current shader respectively.
Arguments
None
Syntax
<IntType> RenderOverType()

RenderTextureMaps
Explanation
Query the renderer’s 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.
Arguments
None
Syntax
<IntType> RenderTextureMaps()

Scene Methods
69 Poser 11
PoserPython Methods Manual

RenderToNewWindow
Explanation
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.
Arguments
None
Syntax
<IntType> RenderToNewWindow()

RenderToQueue
Explanation
Poser Pro Only. Render the given Scene using Queue Manager. The extension of
the filename determines the output type. Path can be provided in full or relative
to the Poser directory.
Arguments
Use 1 for the isMovie value for rendering movies. When writing out JPG the
compression can be specified (10=best compression, 100=best quality). For TIFF
images the compression type can be specified (such as kTIFF_LZW), otherwise the
compression parameter is ignored. Currently supported image format suffixes are
“bmp”, “jpg”, “pct”, “png”, and “tif”.
Syntax
<NoneType> RenderToQueue(<StringType> filepath {<IntType> width,
<IntType> height, <IntType> isMovie, <IntType> compression})

Resolution
Explanation
Get the curent resolution value (DPI).
Arguments
None
Syntax
(<FloatType> res) Resolution()

ResolutionScale
Explanation
Get the curent resolution scale. Choices are: 0 for Full, 1 for Half and 2 for
Quarter.
Arguments
None
Syntax
(<FloatType> scale) ResolutionScale()

ResolvePendingTextures
Explanation
Resolve any texture paths that may not yet have been searched for. In general

Scene Methods
70 Poser 11
PoserPython Methods Manual

Poser will not look for textures unless they are needed. This method forces
textures to be found.
Arguments
None
Syntax
<NoneType> ResolvePendingTextures()

RestoreAll
Explanation
Restore memorized scene state.
Arguments
None
Syntax
<NoneType> RestoreAll()

RestoreLights
Explanation
Restore memorized lights
Arguments
None
Syntax
<NoneType> RestoreLights()

SaveImage
Explanation
Write the current view to an image file by specifying a format suffix (such
as “jpg”) and an output filename. When writing out jpg the compression
can be specified (10=best compression, 100=best quality). For TIFF images
the compression type can be specified (such as kTIFF_LZW), otherwise the
compression parameter is ignored. Currently supported image format suffixes are
“bmp”, “jpg”, “pct”, “png”, and “tif” . Output filename should be a path (either
absolute or relative to the Poser folder).
Arguments
• 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
<NoneType> SaveImage(<StringType> formatSuffix, <StringType> filePath,
<IntType> compression)
Example
scene.SaveImage (“bmp”, “C:\My Documents\My Pictures\mypic.bmp”)

SaveLibraryCamera
Explanation
Save the current cameras to a camera library file (.cm2). The filename should

Scene Methods
71 Poser 11
PoserPython Methods Manual

be a path (either absolute or relative to the Poser folder). Libraries are typically
stored under Poser/Runtime/libraries.
Arguments
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.
Syntax
<NoneType> SaveLibraryCamera(<StringType> filePath, {<IntType>
multiFrame, <IntType> startFrame, <IntType> endFrame})
Example
scene.SaveLibraryCamera(“Runtime\Libraries\ MyCamera.cm2”, 1,25,68)

SaveLibraryFace
Explanation
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.
Arguments
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.
Syntax
<NoneType> SaveLibraryFace(<StringType> filePath, {<IntType> multiFrame =
0, <IntType> startFrame = 0, <IntType> endFrame = 0})
Example
scene.SaveLibraryFace(“\Runtime\Libraries\MyFace.fc2”, 1,25,68)

SaveLibraryFigure
Explanation
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.
Arguments
Enter the complete file name and path.
Syntax
<NoneType> SaveLibraryFigure(<StringType> filePath)
Example
scene.SaveLibraryFigure(“Runtime:Libraries: MyFigure.cr2”)

SaveLibraryHair
Explanation
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.

Scene Methods
72 Poser 11
PoserPython Methods Manual

Arguments
Enter the complete file name and path.
Syntax
<NoneType> SaveLibraryHair(<StringType> filePath)
Example
scene.SaveLibraryHair(“Runtime:Libraries:MyHair. hr2”)

SaveLibraryHand
Explanation
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.
Arguments
Enter the complete file name and path.
Syntax
<NoneType> SaveLibraryHand(<StringType> filePath, {<IntType> multiFrame =
0, <IntType> startFrame = 0, <IntType> endFrame = 0})
Example
scene.SaveLibraryHand(“Runtime:Libraries:MyHair. hd2”)

SaveLibraryLight
Explanation
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.
Arguments
Enter the complete file name and path.
Syntax
<NoneType> SaveLibraryLight(<StringType> filePath, {<IntType> multiFrame,
<IntType> startFrame, <IntType> endFrame})
Example
scene.SaveLibraryLight(“Runtime:Libraries:MyLight. lt2”)

SaveLibraryPose
Explanation
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.
Arguments
Enter the complete file name and path.
Syntax
<NoneType> SaveLibraryPose(<StringType> filePath, {<IntType>
includeMorphTargets, <IntType> multiFrame, <IntType> startFrame,
<IntType> endFrame})
Example
scene.SaveLibraryPose(“Runtime:Libraries:MyPose. pz2”)

Scene Methods
73 Poser 11
PoserPython Methods Manual

SaveLibraryProp
Explanation
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.
Arguments
Enter the complete file name and path.
Syntax
<NoneType> SaveLibraryProp(<StringType> filePath)
Example
scene.SaveLibraryProp(“Runtime:Libraries:MyProp. pp2”)

SceneBBox
Explanation
Get the Bounding Box of the scene in inches.
Arguments
None
Syntax
<BoundingBoxTuple> SceneBBox()

SelectActor
Explanation
Set the current actor (i.e. Select an actor).
Arguments
Enter a valid Poser actor object.
Syntax
<NoneType> SelectActor(<ActorType> actor)
Example
scene.SelectActor(scene.Actor(“GROUND”))

SelectFigure
Explanation
Set the current figure (i.e. Select a figure).
Arguments
Enter a valid Poser figure object.
Syntax
<NoneType> SelectFigure(<FigureType> figure)
Example
scene.SelectFigure(scene.Figure(“JamesCasual”))

SelectMaterial
Explanation
Select the specified material in the Material Room.

Scene Methods
74 Poser 11
PoserPython Methods Manual

Arguments
Enter the material you wish to select.
Syntax
<NoneType> SelectMaterial(<MaterialType> material)

SelectMaterialLayer
Explanation
Select the given material layer in the Material Room.
Arguments
Enter the material layer you wish to select.
Syntax
<NoneType> SelectMaterialLayer(<MaterialLayerType> materialLayer)

SetBackgroundColor
Explanation
Set the background RGB color using values in the range 0.0 to 1.0)
Arguments
• 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> SetBackgroundColor(<FloatType> R, <FloatType> G, <FloatType>
B)
Example
scene.SetBackgroundColor(0.4,0.5,0.6)

SetBackgroundImage
Explanation
Set the background image to the specified file. The filename should be a path
(either absolute or relative to the Poser folder).
Arguments
Enter the complete file name and path.
Syntax
<NoneType> SetBackgroundImage(<StringType> filePath)
Example
scene.SetBackgroundImage(“D:\Images\MyImage.jpg”)

SetBackgroundMovie
Explanation
Set background movie to show behind scene. The filename should be a path
(either absolute or relative to the Poser folder).
Arguments
Enter the complete file name and path.
Syntax
<NoneType> SetBackgroundMovie(<StringType> movieName)

Scene Methods
75 Poser 11
PoserPython Methods Manual

Example
scene.SetBackgroundImage(“D:\Movies\MyMovie.avi”)

SetChanged
Explanation
Mark the document as changed since it was last saved.
Arguments
none
Syntax
<NoneType> SetChanged()
Example

SetCurrentCamera
Explanation
Set the current camera. Note that cameras are a specific kind of actor.
Arguments
Enter a valid Poser camera object.
Syntax
<NoneType> SetCurrentCamera(<ActorType> camera)
Example
SetCurrentCamera(leftCamera)

SetCurrentLight
Explanation
Set the current light. Note that lights are a specific kind of actor.
Arguments
Enter a valid Poser light actor.
Syntax
<NoneType> SetCurrentLight(<ActorType> light)
Example
scene.SetCurrentLight(spotLight)

SetCurrentRenderEngine
Explanation
Set the current render engine.
Arguments
Specify the desired render engine.
Syntax
<NoneType> SetCurrentRenderEngine(<IntType> Engine)

Scene Methods
76 Poser 11
PoserPython Methods Manual

SetDisplayStyle
Explanation
Set interactive display style of the document. Typical values are constants
defined as poser member variables (such as poser.kDisplayCodeWIREFRAME).
Arguments
Enter a valid display code.
Syntax
<NoneType> SetDisplayStyle(<IntType> displayCode)
Example
scene.SetDisplayStyle(poser.kDisplayCodeSMOOTH LINED)

SetEventCallback
Explanation
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.
Arguments
Enter a valid scene object and a valid eventCode.
Syntax
<NoneType> SetEventCallback (<FunctionType> newCD, {<Object> cbArgs})
Example
Click the Sample Callbacks button in the Python palette to see an example using
this method.

SetForegroundColor
Explanation
Set the foreground RGB color using values in the range 0.0 to 1.0)
Arguments
• 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> SetForegroundColor(<FloatType> R, <FloatType> G, <FloatType>
B)
Example
scene.SetForegroundColor(0.4,0.5,0.6)

SetFrame
Explanation
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.
Arguments
Enter a valid frame number.

Scene Methods
77 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SetFrame(<IntType> frame)
Example
scene.SetFrame(23)

SetGeometricOutline
Explanation
Set geometric outline on or off.
Arguments

Syntax
<NoneType> SetFrame(<BoolType> enabled>)
Example

SetGeometricOutlineWelding
Explanation
Set geometric outline welding on or off.
Arguments

Syntax
<NoneType> SetFrame(<BoolType> enabled>)
Example
scene.SetFrame(23)

SetGroundColor
Explanation
Set the ground RGB color using values in the range 0.0 to 1.0)
Arguments
• 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> SetGroundColor(<FloatType> R, <FloatType> G, <FloatType> B)
Example
scene.SetGroundColor(0.4,0.5,0.6)

SetGroundShadows
Explanation
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.
Arguments
Enter 0 to disable ground shadows, or 1 to enable them.

Scene Methods
78 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SetGroundShadows({<IntType> on = 1})
Example
scene.SetGroundShadows(1)

SetMeAsStartupScript
Explanation
Specify the current script as the Python script associated with the current Poser
doc and executed on startup when the document is re-opened.
Arguments
None
Syntax
<NoneType> SetMeAsStartupScript()

SetNumFrames
Explanation
Set the total number of frames of animation. Note that keyframes may be
deleted if animation length is shortened.
Arguments
None
Syntax
<NoneType> SetNumFrames(<IntType> numFrames)

SetOutputRange
Explanation
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.
Arguments
• 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.
Syntax
<NoneType> SetOutputRange(<IntType> x, <IntType> y)
Example
scene.SetOutputRange(25,67)

SetOutputRes
Explanation
Set output resolution (for images). Resolution consists of a horizontal and a
vertical number of pixels.
Arguments
Enter a dimension in pixels using the format x,y.

Scene Methods
79 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SetOutputRes(<IntType> x, <IntType> y)
Example
scene.SetOutput Res(640,480)

SetRenderAntiAliased
Explanation
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.
Arguments
Enter 1 to enable anti-aliasing, or 0 to disable it.
Syntax
<NoneType> SetRenderAntiAliased({<IntType> on = 1})
Example
scene.SetRenderAntiAliased(0)

SetRenderBumpMaps
Explanation
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.
Arguments
Enter 1 to enable bump map use, or 0 to disable it.
Syntax
<NoneType> SetRenderBumpMaps({<IntType> on = 1})
Example
scene.SetRenderBumpMaps(1)

SetRenderCastShadows
Explanation
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.
Arguments
Enter 1 to enable cast shadow rendering, or 0 to disable it.
Syntax
<NoneType> SetRenderCastShadows({<IntType> on = 1})
Example
scene.SetRenderCastShadows(1)

SetRenderDimAutoscale
Explanation
Set the choice for the autoscale resolution dimensions. Options are: 0 for Exact
Size (as given by OutputRes), 1 for Fit to Preview and 2 for Match to Preview.
Arguments
Enter an autoscale option.

Scene Methods
80 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SetRenderDimAutoscale(<IntType> option)
Example
scene.SetRenderDimAutoscale(1)

SetRenderIgnoreShaderTrees
Explanation
Toggle whether or not the render engine will ignore shader trees. 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.
Arguments
Enter 1 to enable ignoring of shader trees, or 0 to disable it.
Syntax
<NoneType> SetRenderIgnoreShaderTrees({<IntType> on = 1})

SetRenderOnBGColor
Explanation
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.
Arguments
Enter 1 to enable rendering over the background color, or 0 to disable it.
Syntax
<NoneType> SetRenderOnBGColor({<IntType> on = 1})
Example
scene.SetRenderOnBGColor(1)

SetRenderOnBGPict
Explanation
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.
Arguments
<NoneType> RenderOnBGPict({<IntType> on = 1})
Syntax
Enter 1 to enable rendering over the current background picture, or 0 to
disable it.
Example
scene.RenderOnBGPicture(0)

SetRenderOnBlack
Explanation
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.

Scene Methods
81 Poser 11
PoserPython Methods Manual

Arguments
Enter 1 to enable rendering against a black background, or 0 to disable it.
Syntax
<NoneType> SetRenderOnBlack({<IntType> on = 1})
Example
scene.SetRenderOnBlack(1)

SetRenderOverType
Explanation
Set the renderer to render over color, black, background picture, or the current
shader tree. Type values are 0, 1, 2, 3 for color, black, bg pict (background
picture), and current shader respectively.
Arguments
Enter the type value for the render-over type you wish to specify.
Syntax
<NoneType> SetRenderOverType({<IntType> type})

SetRenderTextureMaps
Explanation
Toggle the renderer’s 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.
Arguments
Enter 1 to enable bump map use, or 0 to disable it.
Syntax
<NoneType> SetRenderTextureMaps({<IntType> on = 1})
Example
scene.SetRender (1)

SetRenderToNewWindow
Explanation
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.
Arguments
Enter 1 to render to a new window, or 0 to disable it.
Syntax
<NoneType> SetRenderToNewWindow({<IntType> on = 1})
Example
scene.SetRenderToNewWindow(0)

SetResolution
Explanation
Set the resolution value(DPI). Optionally provide an argument for the units (0 for
inches, 1 for cm).

Scene Methods
82 Poser 11
PoserPython Methods Manual

Arguments
Set 0 for inches, 1 for cm
Syntax
<NoneType> SetResolution (<FloatType> scale {, <IntType> unit = 0)
Example
scene.SetResolution(250, 1)

SetResolutionScale
Explanation
Set the choice for the resolution scale.
Arguments
Options are: 0 for Full, 1 for Half and 2 for Quarter.
Syntax
<NoneType> SetResolutionScale(<IntType> scale)
Example
scene.SetResolutionScale(1)

SetShadowColor
Explanation
Set the shadow RGB color using values in the range 0.0 to 1.0)
Arguments
• 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> SetShadowColor(<FloatType> R, <FloatType> G, <FloatType> B)
Example
scene.SetShadowColor(1.0,1.0,0.3)

SetSound
Explanation
Specify the sound file to be associated with this Poser document. Sound files play
during animation.
Arguments
Enter the complete path and file name.
Syntax
<NoneType> SetSound(<StringType> filePath)
Example
scene.SetSound(“C:\My Music\Sound1.wav”)

SetSoundRange
Explanation
Specify the frame range over which the sound should be played
during animation.

Scene Methods
83 Poser 11
PoserPython Methods Manual

Arguments
Enter valid starting and ending frames for the sound.
Syntax
<NoneType> SetSoundRange(<IntType> startFrame, <IntType> endFrame)
Example
scene.SetSoundRange(5,12)

SetStartupScript
Explanation
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).
Arguments
Enter the complete path and file name.
Syntax
<NoneType> SetStartupScript(<StringType> filePath)
Example
scene.SetStartupScript(“\Runtime\Python\script.py”)

SetWorldspaceCallback
Explanation
Set a per-update callback to process scene elements after the entire scene has
been processed to world space.
Arguments
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.
Syntax
<NoneType> SetWorldspaceCallback(<FunctionType> newCB, {<Object>
cbArgs})
Example
(See sample scripts)

ShadowColor
Explanation
Return the shadow RGB color using values in the range 0.0 to 1.0)
Arguments
• 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
(<FloatType> R, <FloatType> G, <FloatType> B) ShadowColor()
Example
scene.ShadowColor(1.0,1.0,0.3)

Scene Methods
84 Poser 11
PoserPython Methods Manual

Sound
Explanation
Return the name of the sound file associated with the current Poser document
that plays during animations.
Arguments
None
Syntax
<StringType> Sound()

SoundRange
Explanation
Return the frame range over which the sound is played during animation.
Returns a tuple containing the start frame and the end frame.
Arguments
None
Syntax
(<IntType>, <IntType>) SoundRange()

StartupScript
Explanation
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).
Arguments
None
Syntax
<StringType> StartupScript()

UpdateBGPreview
Explanation
Updates the preview’s background. Call this function after you modify the
background shader.
Arguments
None
Syntax
<NoneType> UpdateBGPreview()

WacroLights
Explanation
Returns a list of light actors on which a script is to be executed. The script can
then iterate over this list in order to apply light modifications to all lights.
Arguments
None

Scene Methods
85 Poser 11
PoserPython Methods Manual

Syntax
<ActorType list> WacroLights()

WacroMaterialLayers
Explanation
Returns a list of material layers on which a wacro is to be executed. This method
is intended for use inside wacros, they should iterate over this list.
Arguments
None
Syntax
<MaterialLayerType list> GetWacroMaterialLayers()

WacroMaterials
Explanation
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.
Arguments
None
Syntax
<MaterialType list> GetWacroMaterials()

WorldToScreen
Explanation
Takes a set of (x, y, z) world coordinates (the location of a point within the 3D
scene) and returns (x, y, z) screen coordinates (the location of that point relative
to the screen).
Arguments
Enter the x, y, z coordinates of the point for which you wish the screen
coordinates.
Syntax
(<FloatType> x, <FloatType> y, <FloatType> z), WorldToScreen(<FloatType>
x, <FloatType> y, <FloatType> z)

MovieMaker Methods

Antialias
Explanation
Query the antialias settings. A return value of 1 indicates that the option is on,
while a value of 0 indicates that it is off
Arguments
None
Syntax
<IntType> Antialias()

MovieMaker Methods
86 Poser 11
PoserPython Methods Manual

FlashAutoPlay
Explanation
Query the Flash auto-play option. Returns 1 if the option is enabled, 0 if disabled.
Arguments
None
Syntax
<IntType> FlashAutoPlay()

FlashDrawInnerLines
Explanation
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.
Arguments
None
Syntax
<IntType> FlashDrawInnerLines()

FlashDrawOuterLines
Explanation
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.
Arguments
None
Syntax
<IntType> FlashDrawInnerLines()

FlashLineWidth
Explanation
Get the width of drawn lines for Flash export. Note that both inner and outer lines
use the same line width.
Arguments
None
Syntax
<FloatType> FlashLineWidth()

FlashNumColors
Explanation
Get the number of colors to be used for Flash export.
Arguments
None
Syntax
<IntType> FlashNumColors()

MovieMaker Methods
87 Poser 11
PoserPython Methods Manual

FlashOverlapColors
Explanation
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.
Arguments
None
Syntax
<IntType> FlashOverlapColors()

FlashQuantizeAll
Explanation
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.
Arguments
None
Syntax
<IntType> FlashQuantizeAll()

FlashQuantizeFrame
Explanation
Get the frame to be quantized when exporting Flash with the quantize-one-
frame option on.
Arguments
None
Syntax
<IntType> FlashQuantizeFrame()

FlashQuantizeOne
Explanation
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.
Arguments
None
Syntax
<IntType> FlashQuantizeOne()

FrameOptions
Explanation
Return the values for frame rate and increment.
Arguments
None

MovieMaker Methods
88 Poser 11
PoserPython Methods Manual

Syntax
(<IntType> rate, <IntType> increment) FrameOptions()

MakeFlash
Explanation
Write the animation to a Flash file (*.swf).
Arguments
Enter the complete file name and path for the output file.
Syntax
<NoneType> MakeMovieFlash(<StringType> filePath)
Example
mm.MakeFlash(“C:\MyDocuments\myflashmovie.swf”)

MakeMovie
Explanation
Write out the animation to file(s). Filepath can be relative to the Poser application
or absolute. For image files also provide the file format as 3-letter-string additional
argument (eg “png”), When writing out jpg the compression can be specified
(10=best compression, 100=best quality), otherwise the compression parameter
is ignored. Use in conjunction with the SetMovieFormat method to define the
output type.
Arguments
Enter the complete file name and path for the output file.
Syntax
<NoneType> MakeMovie(<StringType> filePath {, <StringType> fileFormat,
<IntType> compression})
Example
moviemaker.SetMovieFormat(2)
moviemaker.MakeMovie(“TestMovie”, “jpg”, 90) or
moviemaker.SetMovieFormat(3)
moviemaker.MakeMovie(“C:\\TestMovie.swf”)

MotionBlur
Explanation
Query the motion blur settings. A return value of 1 indicates that the option is on,
while a value of 0 indicates that it is off. The second parameter is the blur amount
Arguments
None
Syntax
(<IntType> on, <FloatType> amount) MotionBlur()

MovieFormat
Explanation
Return the current movie format setting. See OutputFormats() for available
formats.

MovieMaker Methods
89 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<IntType> MovieFormat()

MovieRenderer
Explanation
Return the current movie renderer setting.
Arguments
None
Syntax
<IntType> MovieRenderer()

OutputEndFrame
Explanation
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.
Arguments
None
Syntax
<IntType> OutputEndFrame()

OutputFormats
Explanation
Get the supported movie output formats. Use list index for SetMovieFormat() call.
Format will look like: [<StringType> Name}, . . .]
Arguments
None
Syntax
<ListType> OutputFormats()

OutputRes
Explanation
Return a tuple containing output resolution (for movies).
Arguments
None
Syntax
(<IntType> x, <IntType> y) OutputRes()

OutputStartFrame
Explanation
Return the first frame to be used in making the movie. All frame numbers in

MovieMaker Methods
90 Poser 11
PoserPython Methods Manual

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.
Arguments
None
Syntax
<IntType> OutputStartFrame()

SetAntialias
Explanation
Toggle the antialias value. 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
Arguments
Enter 0 to disable antialiasing, or 1 to enable it.
Syntax
<NoneType> SetAntialias({<IntType> on = 1})

SetFlashAutoPlay
Explanation
Set the Auto Play option for Flash Export.
Arguments
Enter 1 to enable the option, or 0 to disable it.
Syntax
<NoneType> SetFlashAutoPlay({<IntType> on})
Example
mm.SetFlashAutoPlay(1)

SetFlashDrawInnerLines
Explanation
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.
Arguments
Enter 1 to enable drawing inner lines, or 0 to disable.
Syntax
<NoneType> SetFlashDrawInnerLines({<IntType> on = 0})
Example
mm.SetFlashDrawInnerLines(1)

SetFlashDrawOuterLines
Explanation
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.

MovieMaker Methods
91 Poser 11
PoserPython Methods Manual

Arguments
Enter 1 to enable drawing outer lines, or 0 to disable.
Syntax
<NoneType> SetFlashDrawOuterLines({<IntType> on = 1})
Example
mm.SetFlashDrawOuterLines(1)

SetFlashLineWidth
Explanation
Set the width of drawn lines for Flash export. Note that both inner and outer lines
use the same line width.
Arguments
Enter any valid floating-point number.
Syntax
<NoneType> SetFlashLineWidth({<FloatType> width = 1.0})
Example
mm.SetFlashLineWidth(2.43)

SetFlashNumColors
Explanation
Set the number of colors to be used for Flash export.
Arguments
Enter the number of colors to use.
Syntax
<NoneType> SetFlashNumColors({<IntType> numColors = 4})
Example
mm.SetFlashNumColors(6)

SetFlashOverlapColors
Explanation
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.
Arguments
Enter 1 to enable overlapping colors, or 0 to disable.
Syntax
<NoneType> SetFlashOverlapColors({<IntType> on = 1})
Example
mm.SetFlashOverlapColors(1)

SetFlashQuantizeAll
Explanation
Quantize all frames when exporting flash.

MovieMaker Methods
92 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<NoneType> SetFlashQuantizeAll()

SetFlashQuantizeFrame
Explanation
Specify the frame to be quantized when exporting Flash with the quantize-one-
frame option on.
Arguments
Enter the number of the selected frame.
Syntax
<NoneType> SetFlashQuantizeFrame({<IntType> frame})
Example
mm.SetFlashQuantizeFrame(4)

SetFlashQuantizeOne
Explanation
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.
Arguments
Enter the desired frame number.
Syntax
<NoneType> SetFlashQuantizeOne({<IntType> frame})
Example
mm.SetFlashQuantizeOne(12)

SetFrameOptions
Explanation
Set the values for frame rate and increment.
Arguments
Enter two integer values, for frame rate and frame increment respectively
Syntax
<NoneType> SetFrameOptions(<IntType> rate, <IntType> increment)
Example
moviemaker.SetFrameOptions(24, 4)

SetMotionBlur
Explanation
Set the values for motion blur settings. Default is ON (1), with a value of 0.5. To
turn it off, call the function with a single argument of 0
Arguments
Enter the desired motion blur setting and optionally value.

MovieMaker Methods
93 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> MotionBlur(<IntType> on = 1, {<FloatType> amount})
Example
moviemaker.MotionBlur(1, 0.75)

SetMovieFormat
Explanation
Set the movie format.
Arguments
Enter the desired movie-making output format. See OutputFormats() for available
formats.
Syntax
<NoneType> SetMovieFormat(<IntType> Format)

SetMovieRenderer
Explanation
Set the movie renderer, use the same codes as the scene render engine.
Arguments
Enter the desired movie renderer.
Syntax
<NoneType> SetMovieRenderer(<IntType> Renderer)

SetOutputEndFrame
Explanation
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.
Arguments
Enter the number of the ending frame.
Syntax
<NoneType> SetOutputEndFrame(<IntType> frame)
Example
mm.SetOutputEndFrame(60)

SetOutputRes
NOTE: Deprecated in Poser 9/Poser Pro 2012
Explanation
Set output resolution (for movies).
Arguments
Enter the X and Y resolution in pixels.
Syntax
<NoneType> SetOutputRes(<IntType> x, <IntType> y)
Example
mm.SetOutputRes(640,640)

MovieMaker Methods
94 Poser 11
PoserPython Methods Manual

SetOutputResScale
Explanation
Set output resolution scale (for movies)
Arguments
Enter the scale factor.
Syntax
<NoneType> SetOutputResScale(<FloatType> resScale}
Example
mm.SetOutputResScale(0.5)

SetOutputStartFrame
Explanation
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.
Arguments
Enter the number of the starting frame.
Syntax
<NoneType> SetOutputStartFrame(<IntType> frame)
Example
mm.SetOutputStartFrame(1)

Importer/Exporter Methods

Export
Explanation
Export models using plugins. The file suffix argument is the extension typically
following files of the type to be exported, such as “dxf”. The actual plugin name
may be given (e.g. “File Format HAnim”) to specify which plugin to choose if
there are several plugins that export the same file type. If only one plugin exists
that exports files with the given extension, then this argument may be None. 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 to as an
arguement 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 will be called back for all actors in the scene. If this argument is
omitted, all visible objects will be exported.
Arguments
File Suffix:
• Biovision (BVH Motion): bvh
• 3D Studio Max: 3ds
• AutoCAD: dxf
• Wavefront OBJ: OBJ

Importer/Exporter Methods
95 Poser 11
PoserPython Methods Manual

• Collada: dae
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.
• 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.
Syntax
<NoneType> Export(<StringType> fileSuffix, <StringType> pluginName,
<StringType> filePath, {<DictType> options, <FunctionType>
sceneSelectionCallback})
Example
Imex.Export(“DXF”, “File Format DXF”, “C:\My Documents\Test.dxf”)

ExportOptions
Explanation
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 plug-in 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.
Arguments
Enter a valid export file suffix and plug-in name.
Syntax
<DictType> ExportOptions(<StringType> fileSuffix, <StringType> pluginName)
Example
imex.ExportOptions(“obj”, None)

ExportOptionString
Explanation
Get an export option string for the specified file suffix and plugin name. The
enumeration value is a key from the export options dictionary.
Arguments
Enter a valid export file suffix and plug-in name.
Syntax
<StringType> ExportOptionString(<StringType> fileSuffix, <StringType>
pluginName, <IntType> enumValue)

Importer/Exporter Methods
96 Poser 11
PoserPython Methods Manual

Example
imex.ExportOptionString(“obj”, None, poser.kExOptCodeMULTIFRAME)

Import
Explanation
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.
Arguments
File Suffix:
• Biovision (BVH Motion): bvh
• 3D Studio Max: 3ds
• AutoCAD: dxf
• Wavefront OBJ: OBJ
• Collada: dae
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.
Syntax
<NoneType> Import(<StringType> fileSuffix, <StringType> filePath,
{<DictType> options})
Example
Import(“DXF”, “C:\My Documents\test.dxf”)

ImportOptions
Explanation
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 plug-in 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.
Arguments
Enter a valid import file suffix and plug-in name.
Syntax
<DictType> ImportOption(<StringType> fileSuffix, <StringType> pluginName)
Example
imex.ImportOptions(“OBJ”, none)

ImportOptionString
Explanation
Get an import option string for the specified file suffix and plug-in name. The

Importer/Exporter Methods
97 Poser 11
PoserPython Methods Manual

enumeration value is a key from the import options dictionary.

Arguments
Enter a valid import file suffix and plug-in name.
Syntax
<StringType> ImportOptionString(<StringType> fileSuffix, <StringType>
pluginName, <IntType> enumValue)
Example
imex.ImportOptionString(“OBJ”, None, poser.kImOptCodePERCENTFIGSIZE)

Animation Set Methods

AddAttribute
Explanation
Adds a new attribute to the current animation set.
Arguments
• Attribute Name: Enter the name of the attribute you wish to add.
• Value: Enter the desired value of the attribute.
Syntax
<NoneType> AddAttribute(<StringType> name, <StringType> value)
Example
animset.AddAttribute(“MyAttribute”,1)

AddObjectRange
Explanation
Add an object range to the animation set. The entity provided must be a figure,
actor, or parameter.
Arguments
• 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)
Example
animset.AddObjectRange(someActor,5,20)

Attributes
Explanation
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.
Arguments
None
Syntax
<TupleType list> Attributes()

Importer/Exporter Methods
98 Poser 11
PoserPython Methods Manual

ObjectRange
Explanation
Get the object range for the specified animation set.
Arguments
None
Syntax
(<IntType> startFrame, <IntType> endFrame) ObjectRange()

Parameters
Explanation
Get a list of parameters to which this animation set applies.
Arguments
None
Syntax
<ParmType list> Parameters()

RemoveAttribute
Explanation
Remove an existing attribute from the current animation set.
Arguments
• Attribute Name: Enter the name of the attribute you wish to add.
• Value: Enter the desired value of the attribute.
Syntax
<NoneType> RemoveAttribute(<StringType> name, {<StringType> value})
Example
animset.RemoveAttribute(“MyAttribute”, 1)

RemoveObjectRange
Explanation
Remove an existing object range from the current animation set.
Arguments
• 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)
Example
animset.RemoveObjectRange(someActor,5,20)

Importer/Exporter Methods
99 Poser 11
PoserPython Methods Manual

Actor Methods

AddKeyFrame
Explanation
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.
Arguments
Enter a valid frame number.
Syntax
<NoneType> AddKeyFrame({<IntType> frame})
Example
AddKeyFrame(81)

AlignmentRotationXYZ
Explanation
Get a tuple comprising the ordered rotation alignment for this actor. (order is X,
Y, Z)
Arguments
None
Syntax
(<FloatType>, <FloatType>, <FloatType>) AlignmentRotationXYZ()

AltGeomFileName
Explanation
Get the name of the alternate geometry file used by this actor (if specified).
Arguments
None
Syntax
<StringType> AltGeomFileName()

AmbientOcclusion
Explanation
Query whether this light (if this actor is an image light) is using ambient occlusion.
Arguments
None
Syntax
<IntType> AmbientOcclusion()

AmbientOcclusionBias
Explanation
Get the ambient occlusion bias of this light (if this actor is an image light).

Actor Methods
100 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<FloatType> AmbientOcclusionBias()

AmbientOcclusionDistance
Explanation
Get the ambient occlusion maximum distance of this light (if this actor is an
image light).
Arguments
None
Syntax
<FloatType> AmbientOcclusionDistance()

AmbientOcclusionStrength
Explanation
Get the ambient occlusion strength of this light (if this actor is an image light).
Arguments
None
Syntax
<FloatType> AmbientOcclusionStrength()

AnimatableOrigin
Explanation
Query whether this actor’s origins can be animated. Returns 1 if the origins can
be animated, and 0 if they cannot.
Arguments
None
Syntax
<IntType> AnimatableOrigin()

AtmosphereStrength
Explanation
Get the atmosphere strength of this light (if this actor is a light).
Arguments
None
Syntax
<FloatType> AtmosphereStrength()

BackfaceCull
Explanation
Query the actor’s backface culling flag.

Actor Methods
101 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<IntType> BackfaceCull()

Base
Explanation
If the actor is a deformer, this method returns its base actor.
Arguments
None
Syntax
<ActorType> ActorBase()

Bends
Explanation
Query whether or not the actor’s bend flag is set.
Arguments
None
Syntax
<IntType> Bends()

CastsShadows
Explanation
Query whether this actor casts shadows.
Arguments
None
Syntax
<IntType> CastsShadows()

Children
Explanation
Get a list of the actors that are the children of the actor given.
Arguments
None
Syntax
<ActorType List> Children()

ClearLocalTransformCallback
Explanation
Clear the local transform callback.
Arguments
None

Actor Methods
102 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> ClearLocalTransformCallback()

ClearVertexCallback
Explanation
Clear the vertex callback.
Arguments
None
Syntax
<NoneType> ClearVertexCallback()

CreaseAngle
Explanation
Get the actor’s crease angle.
Arguments
None
Syntax
<FloatType> CreaseAngle()

CreateHairGroup
Explanation
Create a new hair group.
Arguments
Specify the name of the hair group you wish to create.
Syntax
<HairType> CreateHairGroup(<StringType> name)

CreateValueParameter
Explanation
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.
Arguments
Enter a name for the new parameter.
Syntax
<ParmType> CreateValueParameter(<StringType> valueParmName)
Example
parm = actor.CreateValueParameter(“MyNewParameter”)

CustomData
Explanation
Get custom data associated with this actor. Returns None if no data exists for
that key.

Actor Methods
103 Poser 11
PoserPython Methods Manual

Arguments
Enter the key for the actor.
Syntax
<StringType>CustomData(<StringType>key)

Delete
Explanation
Delete the actor from the scene if possible. Note that you cannot delete a body
part from a figure.
Arguments
None
Syntax
<NoneType> Delete()

DeleteKeyFrame
Explanation
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.
Arguments
Enter a valid frame number.
Syntax
<NoneType> DeleteKeyFrame({<IntType> frame})
Example
parm.DeleteKeyFrame(30)

DisplacementBounds
Explanation
Get the actor’s displacement bounds.
Arguments
None
Syntax
<FloatType> DisplacementBounds()

DisplayStyle
Explanation
Get the interactive display style for this actor. Typical return values correspond to
poser member variable constants (such as poser.kDisplayCodeWIREFRAME).
Arguments
Enter a valid display code.
Syntax
<NoneType> SetDisplayStyle(<IntType> displayCode)
Example
actor.SetDisplayStyle(poser.kDisplayCode SMOOTHSHADED)

Actor Methods
104 Poser 11
PoserPython Methods Manual

DropToFloor
Explanation
Drop the actor downward (along the Y axis) until it touches the floor (Y==0).
Arguments
None
Syntax
<NoneType> DropToFloor()

EndPoint
Explanation
Get the position of the current actor’s endpoint. The endpoint is typically also
the origin of an object’s child. It’s 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.
Arguments
None
Syntax
(<FloatType> x, <FloatType> y, <FloatType> z) EndPoint()

GeomFileName
Explanation
Returns the filename of the geometry bring used by the figure, if any.
Arguments
None
Syntax
<StringType> figure.GeomFileName()

Geometry
Explanation
Get the geometry for the actor. The returned geometry object can then be
queried for vertex, set, or polygon information.
Arguments
None
Syntax
<GeomType> Geometry()

Gimbal
Explanation
Get the gimbal information for the actor. This method returns a tuple of tuples.
The first sub-tuple contains the gimbal order (e.g. (1, 2, 0) for Y, Z, X). The second
contains the parameters that correspond to the x, y, and z rotations respectively.
Arguments
None

Actor Methods
105 Poser 11
PoserPython Methods Manual

Syntax
((<IntType>, <IntType>, <IntType>), (<ParmType>, <ParmType>,
<ParmType>)) Gimbal()

HairGroup
Explanation
Get the hair group specified by the index.
Arguments
Enter the index of the desired hair group.
Syntax
<HairType> HairGroup(<IntType> index)

InternalName
Explanation
Get the (internal) name for the actor. The specified string is a unique name ID
internal to Poser.
Arguments
None
Syntax
<StringType> InternalName()

IsBase
Explanation
Return true only if the actor is a base. Bases are targets of deformation for
deformers such as magnets.
Arguments
None
Syntax
<IntType> IsBase()

IsBodyPart
Explanation
Return true only if the actor is a body part.
Arguments
none
Syntax
<IntType> IsBodyPart()

IsCamera
Explanation
Return true only if the actor is a camera.
Arguments
None

Actor Methods
106 Poser 11
PoserPython Methods Manual

Syntax
<IntType> IsCamera()

IsControlProp
Explanation
Return true only if scene object is a control prop.
Arguments
None
Syntax
<IntType> IsControlProp()

IsDeformer
Explanation
Return true only if the actor is a deformer.
Arguments
None
Syntax
<IntType> IsDeformer()

IsFigure
Explanation
Return true only if scene object is a figure.
Arguments
None
Syntax
<IntType> IsFigure()

IsHairProp
Explanation
Return true only if actor is a hair prop.
Arguments
None
Syntax
<IntType> IsHairProp()

IsLight
Explanation
Return true only if the actor is a light.
Arguments
None
Syntax
<IntType> IsLight()

Actor Methods
107 Poser 11
PoserPython Methods Manual

IsMeasurement
Explanation
Return true only if scene object is a measurement.
Arguments
None
Syntax
<IntType> IsMeasurement()

IsParm
Explanation
Return true only if scene object is a parameter.
Arguments
None
Syntax
<IntType> IsParm()

IsProp
Explanation
Return true only if the actor is a prop.
Arguments
None
Syntax
<IntType> IsProp()

IsZone
Explanation
Return true only if the actor is a zone. Zones are regions acted upon by
deformers such as magnets.
Arguments
None
Syntax
<IntType> IsZone()

ItsFigure
Explanation
Get the figure of which this actor is a part. The return value is a figure object.
Arguments
None
Syntax
<FigureType> ItsFigure()

Actor Methods
108 Poser 11
PoserPython Methods Manual

JointVertexWeights
Explanation
Get a list of vertex weights for the specified joint axis on this actor.
Arguments
The axis argument should be ‘x’, ‘y’, or ‘z’. If no such joint is present, the method
will return None.
Syntax
<FloatType list> JointVertexWeights(<StringType> axis)
Example
actor.JointVertexWeight(X)

LightAttenType
Explanation
Get the falloff type of the light (if this actor is a light). Possible falloff types
are poser.kLightCodePOSER, poser.kLightCodeINVLINEARATTEN and poser.
kLightCodeINVSQUAREFALLOFF.
Arguments
None
Syntax
<IntType> LightAttenType()

LightOn
Explanation
If the current actor is an image light, query whether it is On.
Arguments
None
Syntax
<IntType> LightOn()

LightType
Explanation
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).
Arguments
None
Syntax
<IntType> LightType()

LoadMaterialCollection
Explanation
Load a material collection for this actor.
Arguments
Enter the file name of the material collection you wish to load.

Actor Methods
109 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> LoadMaterialCollection(<StringType> FileName)

LoadMorphTargetFile
Explanation
Load the morph target to the actor.
Arguments
Enter the file name of the morph target you wish to load.
Syntax
<NoneType>LoadMorphTargetFile(<StringType> FileName)

LocalDisplacement
Explanation
Get a tuple comprising the local displacement for this actor.
Arguments
None
Syntax
(<FloatType> tx, <FloatType> ty, <FloatType> tz ) LocalDisplacement()

LocalMatrix
Explanation
Get the local matrix for the actor. The local matrix is the matrix that describes
the model’s relative relationship to its parent in the hierarchy. Thus the final world
matrix of an object is made by concatenating its parent’s world matrix with its
local matrix to produce its world matrix.
Arguments
None
Syntax
<FloatType 4x4 Tuple> LocalMatrix()

LocalQuaternion
Explanation
Get a tuple comprising the quaternion local rotation for this actor.
Arguments
None
Syntax
(<FloatType> qw, <FloatType> qx, <FloatType> qy, <FloatType> qz )
LocalQuaternion()

MarkGeomChanged
Explanation
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.

Actor Methods
110 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<NoneType> MarkGeomChanged()

Material
Explanation
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.
Arguments
Enter a valid material name.
Syntax
<MaterialType> FindMaterialByName(<StringType> name)
Example
skinMat = actor.FindMaterialByName(“skin”)

Materials
Explanation
Get a list of the materials available to the actor. Note that these materials may
actually belong to a parent figure.
Arguments
None
Syntax
<MaterialType List> Materials()
Example
matsList = actor.Materials()

MeasurementValue
Explanation
Get the value for a measurement (if this actor is a measurement).
Arguments
None
Syntax
<StringType> MeasurementValue()
Example

Memorize
Explanation
Set the actor’s default parameter values to the current values so that the actor
can be reset later (See actor.Reset()).
Arguments
None

Actor Methods
111 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> Memorize()

Name
Explanation
Get the (external) name for the current actor. The specified name is the same
one seen in Poser’s GUI pull-down menus.
Arguments
None
Syntax
<StringType> Name()

NextKeyFrame
Explanation
Get the next frame in which the parameter has a key frame set.
Arguments
None
Syntax
<IntType> NextKeyFrame()

NumHairGroups
Explanation
Returns the number of hair groups.
Arguments
None
Syntax
<IntType> NumHairGroups()

NumbSubdivLevels
Explanation
Get the number of subdivision levels for this actor.
Arguments
None
Syntax
<IntType>NumbSubdivLevels()

NumbSubdivRenderLevels
Explanation
Get the number of subdivision levels for this actor.
Arguments
None
Syntax
<IntType>NumbSubdivRenderLevels()

Actor Methods
112 Poser 11
PoserPython Methods Manual

OnOff
Explanation
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.
Arguments
None
Syntax
<IntType> OnOff()

Orientation
Explanation
Get the orientation of the actor’s coordinate system (x,y,z ordered rotation).
ArgumenNone
Syntax
(<FloatType> x, <FloatType> y, <FloatType> z) Orientation()

Origin
Explanation
Get the position of the current actor’s origin in world space.
Arguments
None
Syntax
(<FloatType> x, <FloatType> y, <FloatType> z) Origin()

Parameter
Explanation
Get the named parameter object. The string argument is the internal parameter
name (e.g. “xtran”).
Arguments
Enter a valid internal parameter name
Syntax
<ParmType> Parameter(<StringType> parmName)
Example
parm = Parameter(“xtran”)

ParameterByCode
Explanation
Get the first parameter object matching the given code. Typical code
values are constants defined as poser member variables (such as poser.
kParmCodeXTRAN).
Arguments
Enter a valid parameter code.
Syntax
<ParmType> ParameterByCode(<IntType> parmCode)

Actor Methods
113 Poser 11
PoserPython Methods Manual

Example
parm = ParameterByCode(poser.kParmCodeXSCALE)

Parameters
Explanation
Get the settable parameters for the current actor. The return value is a
list of parameter objects such as those depicted in Poser’s GUI dials (e.g.
“TranslationX”).
Arguments
None
Syntax
<ParmType List> Parameters()

Parent
Explanation
Get the parent actor of the current actor.
Arguments
None
Syntax
<ActorType> Parent()

PointAt
Explanation
Set the target actor for this actor to point towards.
Arguments
Enter the actor that you wish this actor to point at.
Syntax
<NoneType> PointAt(<ActorType> target)
Examples:
ACTOR.PointAt(actor)
Sets ACTOR to point at actor.

PrevKeyFrame
Explanation
Get the previous frame in which the parameter has a key frame set.
Arguments
None
Syntax
<IntType> PrevKeyFrame()

RayTraceShadows
Explanation
Query whether this light (if this actor is a light) is using Raytracing for shadows.

Actor Methods
114 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<IntType> RayTraceShadows()

RemoveValueParameter
Explanation
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.
Arguments
Enter the name of the parameter you wish to delete.
Syntax
<NoneType> RemoveValueParameter(<StringType> valueParmName)
Example
actor.RemoveValueParameter(“MyNewParameter”)

Reset
Explanation
Reset the actor to its default, or last memorized, values (See actor.Memorize()).
Arguments
None
Syntax
<NoneType> Reset()

Restore
Explanation
Restores the actor in a more complete fashion than Actor.Reset(). Actor.Restore()
works exactly as Edit > Restore > Object.
Arguments
None
Syntax
<NoneType> Restore()

SaveMaterialCollection
Explanation
Save the material collection of this actor. Note that only selected materials
will be included. See the SetSelected and Selected methods in the Material
Methods section for information on selecting and querying selection of materials.
Arguments
Enter the file name for the material collection.
Syntax
<NoneType> SaveMaterialCollection(<StringType> FileName)

Actor Methods
115 Poser 11
PoserPython Methods Manual

ScaleMatrix
Explanation
Get the scale matrix for the actor.
Arguments
None
Syntax
<FloatType 4x4 Tuple> ScaleMatrix()

SetAlignmentRotationXYZ
Explanation
Set the tuple comprising the ordered rotation alignment for this actor.
Arguments
Enter valid floating-point values for X, Y, and Z rotation (order is X, Y, and Z).
Angles are in degrees.
Syntax
<NoneType> SetAlignmentRotationXYZ(<FloatType> Rx, <FloatType> Ry,
<FloatType> Rz )
Example
actor.SetAlignmentRotationXYZ(4.53, 7.61, 1.01)

SetAmbientOcclusion
Explanation
Set whether this light (if this actor is an image light) is using ambient occlusion.
Arguments
Enter 1 to use ambient occlusion, or 0 to disable ambient occlusion for this light.
Syntax
<NoneType> SetAmbientOcclusion(<IntType> ambientocclusion)

SetAmbientOcclusionBias
Explanation
Set the ambient occlusion bias of this light (if this actor is an image light).
Arguments
Enter the desired bias for this light.
Syntax
<NoneType> SetAmbientOcclusionBias(<FloatType> bias)

SetAmbientOcclusionDistance
Explanation
Set the ambient occlusion maximum distance of this light (if this actor is an image
light).
Arguments
Enter the desired maximum distance for this light.
Syntax
<NoneType> SetAmbientOcclusionDistance(<FloatType> distance)

Actor Methods
116 Poser 11
PoserPython Methods Manual

SetAmbientOcclusionStrength
Explanation
Set the ambient occlusion strength of this light (if this actor is an image light).
Arguments
Enter the ambient occlusion strength value.
Syntax
<NoneType> SetAmbientOcclusionStrength(<FloatType> strength)

SetAnimatableOrigin
Explanation
Set whether this actor’s origins can be animated. Set to 1 if the origins can be
animated, and 0 if they cannot.
Syntax
<NoneType> SetAnimatableOrigin(<IntType> animatable)

SetAtmosphereStrength
Explanation
Set the atmosphere strength for this light (if this actor is a light).
Arguments
Atmosphere strength value.
Syntax
<NoneType> SetAtmosphereStrength(<FloatType> atmStrength)
Example
actor.SetAtmosphereStrength(0.15)

SetBackfaceCull
Explanation
Set the actor’s backface culling flag.
Arguments
Enter 1 to activate backface culling during rendering, or 0 to disable backface
culling.
Syntax
<NoneType> SetBackfaceCull(<IntType> on = 1)

SetBends
Explanation
Sets the actor’s bend flag.
Arguments
Enter 1 to set the flag, 0 to disable it.
Syntax
<NoneType> SetBends({<IntType> bends=<1 or 0>})
Example
SetBends(bends=1)

Actor Methods
117 Poser 11
PoserPython Methods Manual

SetCastsShadows
Explanation
Set whether this actor casts shadows.
Arguments
Enter 1 to cast shadows, or 0 to disable shadows.
Syntax
<NoneType> SetCastsShadows(<IntType> Cast)

SetCreaseAngle
Explanation
Set the actor’s crease angle.
Arguments
Crease angle in degrees.
Syntax
<NoneType> SetCreaseAngle(<FloatType> angle)

SetCustomData
Explanation
Set custom data associated with this actor. This data will always be saved with a
scene file.
Arguments
The additional flags can be set to 1 to make this data also be included in
material sets and/or poses. Passing None as value will clear the custom data for
that key.
Syntax
<NoneType>SetCustomData(<StringType>key, <StringType> value, <IntType>
storeWithPoses, <IntType> storeWithMaterials)

SetDisplacementBounds
Explanation
Set the actor’s displacement bounds.
Arguments
Displacement bounds value.
Syntax
<NoneType> SetDisplacementBounds(<FloatType> dispBounds)
Example
actor.SetDisplacementBounds(0.9)

SetDisplayOrigin
Explanation
Set if the origin of this actor should be visible in the preview.
Arguments
none

Actor Methods
118 Poser 11
PoserPython Methods Manual

Syntax
<NoneType>DisplayOrigin(<IntType>display)
Example

SetDisplayStyle
Explanation
Set the display style to be used for this actor. Typical display code constants are
defined as poser member variables (e.g. poser.kDisplayCodeWIREFRAME).
Arguments
Enter a valid display code.
Syntax
<NoneType> SetDisplayStyle(<IntType> displayCode)
Example
actor.SetDisplayStyle(poser.kDisplayCodeFLATLINED)

SetEndPoint
Explanation
Set the position of the endpoint of the actor. Typically the endpoint is the origin
of an object’s child. It’s 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.)
Arguments
Enter valid X, Y, and Z coordinates.
Syntax
<NoneType> SetEndpoint(<FloatType> x, <FloatType> y, <FloatType> z)
Example
actor.SetEndpoint(5.38, 3.90, 1.23)

SetGeometry
Explanation
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().
Arguments
Specify a valid Poser geometry object.
Syntax
<NoneType> SetGeometry(<GeomType> geometry)
Example
actor.SetGeometry(geom)

SetIncludeInBoundingBox
Explanation
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

Actor Methods
119 Poser 11
PoserPython Methods Manual

to 0 to exclude actor.
Arguments
Enter 1 to include the actor, or 0 to exclude it.
Syntax
<NoneType> SetIncludeInBoundingBox({<IntType> on = 1})
Example
actor.SetIncludeInBoundingBox(1)

SetKinectRotMatrix
Explanation
Sets the local rotation values for the actor based on this world matrix.
Compensates for orientation.
Arguments
none
Syntax
SetKinectRotMatrix(<FloatType 4x4 Tuple>)
Example

SetLightAttenType
Explanation
Set the falloff type of the light to a specified value. Typical values are
constant light falloff codes defined as poser member variables such as poser.
kLightCodeINVSQUAREFALLOFF.
Arguments
Enter a valid light attenuation code.
Syntax
<NoneType> SetLightAttenType(<IntType> lightAttenTypeCode)

SetLightOn
Explanation
If the current actor is an image light, toggle it on or off. A value of 1 sets the light
actor to On; a value of 0 sets it to OFF.
Arguments
Enter a value of 1 or 0.
Syntax
<NoneType> SetLightOn(<IntType> lightOn)

SetLightType
Explanation
Set the type of the light to a specified value. Typical values are constant light
codes defined as poser member variables such as poser.kLightCodeINFINITE.
Arguments
Enter a valid light code.

Actor Methods
120 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SetLightType(<IntType> lightTypeCode)
Example
actor.SetLightType(poser.kLightCodeSPOT)

SetLocalTransformCallback
Explanation
Set a per-update callback to process the actor’s local transformation. User-
defined callback function is called every time actor undergoes a local transform.
Arguments
The callback function should take an actor argument and make desired
changes to that actor.
Syntax
<NoneType> SetLocalTransformCallback(<FunctionType> newCB, {<Object>
cbArgs})

SetName
Explanation
Renames the current actor.
Arguments
Enter a valid actor name
Syntax
<NoneType> actor.setName(<StringType> ActorName)
Example
actor.setName(MyNewActor)

SetNumbSubdivLevels
Explanation
Set the number of subdivision levels for this actor.
Arguments
none
Syntax
<NoneType>SetNumbSubdivLevels(<IntType>)
Example

SetNumbSubdivRenderLevels
Explanation
Set the number of subdivision levels for this actor.
Arguments
none
Syntax
<NoneType>SetNumbSubdivRenderLevels(<IntType>)

Actor Methods
121 Poser 11
PoserPython Methods Manual

Example

SetOnOff
Explanation
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.
Arguments
Enter 1 to display the actor, or 0 to toggle it off.
Syntax
<NoneType> SetOnOff(<IntType> on)
Example
actor.SetOnOff(0)

SetOrientation
Explanation
Set the orientation of the actor’s coordinate system in x, y, z ordered rotation.
Arguments
Enter valid X, Y, and Z coordinates.
Syntax
<NoneType> SetOrientation(<FloatType> x, <FloatType> y, <FloatType> z)
Example
actor.SetOrientation(1.83, 4.0, 2.47)

SetOrigin
Explanation
Set the position of the actor’s origin in local coordinates.
Arguments
Enter valid X, Y, and Z coordinates.
Syntax
<NoneType> SetOrigin(<FloatType> x, <FloatType> y, <FloatType> z)
Example
actor.SetOrigin(1.83, 4.0, 2.47)

SetParameter
Explanation
Set the current value of the parameter. The string argument is the external
parameter name (e.g. “TranslationX”).
Arguments
• Parameter Name: Enter a valid parameter name.
• Value: Enter a valid value for the selected parameter.
Syntax
<NoneType> SetParameter(<StringType> parmName, <FloatType> value)

Actor Methods
122 Poser 11
PoserPython Methods Manual

Example
actor.SetParameter(poser.kParmCodeXSCALE,75)

SetParent
Explanation
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.
Arguments
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.
Syntax
<NoneType> SetParent(<ActorType> newParent, {<IntType> inheritBends = 0,
<IntType> realign = 0})
Example
childActor.SetParent(ParentActor, 1, 0)

SetRangeConstant
Explanation
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.
Arguments
Enter valid start and end frame numbers.
Syntax
<NoneType> SetRangeConstant(<IntType> startFrame, <IntType> endFrame)
Example
actor.SetRangeConstant(12,40)

SetRangeLinear
Explanation
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.
Arguments
Enter valid start and end frame numbers.
Syntax
<NoneType> SetRangeLinear(<IntType> startFrame, <IntType> endFrame)
Example
actor.SetRangeLinear(12,40)

Actor Methods
123 Poser 11
PoserPython Methods Manual

SetRangeSpline
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
Arguments
Enter valid start and end frame numbers.
Syntax
<NoneType> SetRangeSpline(<IntType> startFrame, <IntType> endFrame)
Example
actor.SetRangeSpline(12,40)

SetRayTraceShadows
Explanation
Set whether this light (if this actor is a light) is using raytracing for shadows.
Arguments
Enter 1 to use raytracing, or 0 to disable raytracing for this light.
Syntax
<NoneType> SetRayTraceShadows(<IntType> on = 1)

SetShadingRate
Explanation
Set the actor’s minimum shading rate.
Arguments
Minimum shading rate value.
Syntax
<NoneType> SetShadingRate(<FloatType> minShadingRate)
Example
actor.SetShadingRate(0.6)

SetShadow
Explanation
Set whether this light (if this actor is a light) is producing shadows.
Arguments
Enter 1 to enable shadows, or 0 to disable shadows for this light.
Syntax
<NoneType> SetShadow(<IntType> shadow)

SetShadowSamples
Explanation
Set the number of shadow rays for this light (if this actor is a light and using
raytraced shadows).

Actor Methods
124 Poser 11
PoserPython Methods Manual

Arguments
none
Syntax
<NoneType> SetShadowSamples(<IntType> samples)

SetShadowBiasMax
Explanation
Set the maximum shadow bias for depth map shadows on this light (if this actor is
a light).
Arguments
Maximum shadow bias value.
Syntax
<NoneType> SetShadowBiasMax(<FloatType> maxShadowBias)
Example
actor.SetShadowBiasMax(2.3)

SetShadowBiasMin
Explanation
Set the minimum shadow bias for depth map shadows on this light (if this actor is
a light).
Arguments
Minimum shadow bias value.
Syntax
<NoneType> SetShadowBiasMin(<FloatType> minShadowBias)
Example
actor.SetShadowBiasMin(0.3)

SetShadowBlurRadius
Explanation
Set the shadow map blur radius for this light (if this actor is a light).
Arguments
Shadow blur radius value.
Syntax
<NoneType> SetShadowBlurRadius(<IntType> shadowBlurRad)
Example
actor.SetShadowBlurRadius(5)

SetShadowRaytraceSoftness
Explanation
Sets the amount of softness for raytraced shadows.
Arguments
Softness radius value.
Syntax
<NoneType> SetShadowRaytraceSoftness(<IntType> SoftnessRad)

Actor Methods
125 Poser 11
PoserPython Methods Manual

Example
actor.SetShadowRaytraceSoftness(5)

SetSmoothPolys
Explanation
Set whether polygon smoothing is enabled for this actor.
Arguments
Enter 1 to smooth polygons during rendering, or 0 to disable polygon smoothing.
Syntax
<NoneType> SetSmoothPolys(<IntType> Smooth)

SetSplineBreak
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
Arguments
Enter valid frame numbers then enter 1 for on and 0 for off.
Syntax
<NoneType> SetSplineBreak({<IntType> frame, <IntType> on})
Example
actor.SetSplineBreak(12,0)

SetStatic
Explanation
Set the status of static parameters on the actor. Argument defaults to 1,
specifying that the actor’s parameters are static and will not change during
animation. To specify non-static parameters, this function should be called with
a 0 argument.
Arguments
Enter 1 to specify static parameters, or 0 to specify non-standard parameters
Syntax
<NoneType> SetStatic(<IntType> on = 1)
Example
actor.SetStatic(0)

SetSubdivideWithFigure
Explanation
Set the number of subdivision levels for this actor.
Arguments
none
Syntax
<NoneType>SetSubdivideWithFigure(<IntType>)

Actor Methods
126 Poser 11
PoserPython Methods Manual

Example

SetVertexCallback
Explanation
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.
Arguments
The callback function should take an actor object and make desired
modifications to it.
Syntax
<NoneType> SetVertexCallback(<FunctionType> newCB, {<Object> cbArgs})
Example
(See sample script)

SetVisible
Explanation
Set the display status of the actor in the scene.
Arguments
Argument should be set to 1 to display the actor and 0 to turn actor display off.
Syntax
<NoneType> SetVisible(<IntType> visible)

SetVisibleInCamera
Explanation
Set whether this actor is visible for the camera.
Arguments
Set to 1 to make the actor visible in the camera and render, or 0 to turn to not
render the object. If set to 0, the object will still be part of calculations but will not
be visible.
Syntax
<NoneType> SetVisibleInCamera(<IntType> Visible)

SetVisibleInIDL
Explanation
Set whether this actor emits indirect light.
Arguments
Set to 1 to have the actor participate in IDL calculations, or 0 to prevent
participation.
Syntax
<NoneType> SetVisibleInIDL(<IntType> Visible)

Actor Methods
127 Poser 11
PoserPython Methods Manual

SetVisibleInReflections
Explanation
Set whether this actor is visible in reflections.
Arguments
Enter 1 to make actor visible in reflections during rendering, or 0 to make it
invisible.
Syntax
<NoneType> SetVisibleInReflections(<IntType> on = 1)

SetVisibleInRender
Explanation
Set whether this actor is visible in renders.
Arguments
Enter 1 to make actor visible in the rendered image, or 0 to make it invisible.
Syntax
<NoneType> SetVisibleInRender(<IntType> on = 1)

ShadingRate
Explanation
Get the actor’s minimum shading rate.
Arguments
None
Syntax
<FloatType> ShadingRate()

Shadow
Explanation
Query whether this light (if this actor is a light) is producing shadows.
Arguments
None
Syntax
<IntType> Shadow()

ShadowBiasMax
Explanation
Get the maximum shadow bias for depth map shadows on this light (if this actor
is a light).
Arguments
None
Syntax
<FloatType> ShadowBiasMax()

Actor Methods
128 Poser 11
PoserPython Methods Manual

ShadowBiasMin
Explanation
Get the minimum shadow bias for depth map shadows on this light (if this actor is
a light).
Arguments
None
Syntax
<FloatType> ShadowBiasMin()

ShadowBlurRadius
Explanation
Get the shadow map blur radius for this light (if this actor is a light).
Arguments
None
Syntax
<IntType> ShadowBlurRadius()

ShadowRaytraceSoftness
Explanation
Get the softness of raytraced shadow for this light (if this actor is a light and using
raytraced shadows).
Arguments
None
Syntax
<FloatType> ShadowRaytraceSoftness()

ShadowSamples
Explanation
Get the number of shadow rays for this light (if this actor is a light and using
raytraced shadows).
Arguments
None
Syntax
<IntType> ShadowSamples()

SmoothPolys
Explanation
Query whether polygon smoothing is enabled for this actor.
Arguments
None
Syntax
<IntType> SmoothPolys()

Actor Methods
129 Poser 11
PoserPython Methods Manual

SpawnTarget
Explanation
Creates a new morph channel on the object using the current state of the
vertices. Typically used when while an actor is being deformed.
Arguments
Enter a name for the new morph channel.
Syntax
<NoneType> SpawnTarget(<StringType> label
Example
actor.SpawnTarget(“MyNewMorphTarget”)

SpawnTargetFromGeometry
Explanation
Creates a new morph channel on the object using a geometry.
Arguments
The geometry argument is the deformation target, and the label provides a
name for the new morph channel.
Syntax
<NoneType> SpawnTargetFromGeometry(<GeomType> geometry, <StringType>
label)
Example
actor.SpawnTargetFromGeometry(geom, “MyMorphTarget”)

Static
Explanation
Get the status of the current actor’s 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.
Arguments
None
Syntax
<IntType> Static()

SubdivGeometry
Explanation
Get the subdivided geometry for the actor. The returned geometry object
can then be queried for vertex, set, or polygon information. The number of
subdivisons can be passed as an optional paraemter - if the parameter is missing
or negative, the geometry will be subdivided to NumbSubdivRenderLevels(). It is
a copy of the geometry, any changes to it will not affect the actor. This method
works only on props, for body parts you have to use the SubdivGeometry()
method of the figure object.
Arguments
None

Actor Methods
130 Poser 11
PoserPython Methods Manual

Syntax
<GeomType> SubdivGeometry({<IntType> levels})

SubdivideWithFigure
Explanation
Get the number of subdivision levels for this actor.
Arguments
None
Syntax
<IntType>SubdivideWithFigure()

TwistVertexWeights
Explanation
Get a list of vertex weights for the specified twist axis on this actor.
Arguments
The axis argument should be ‘x’, ‘y’, or ‘z’. If no such joint is present, the method
will return None.
Syntax
<FloatType list> TwistVertexWeights(<StringType> axis)
Example
actor.TwistVertexWeight(X)

ValueParameter
Explanation
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.
Arguments
Enter a valid parameter name.
Syntax
<ParmType> ValueParameter(<StringType> valueParmName)
Example
parm = actor.ValueParameter(MyNewParameter)

ValueParameters
Explanation
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.
Arguments
None
Syntax
<ParmType List> ValueParameters()

Actor Methods
131 Poser 11
PoserPython Methods Manual

Visible
Explanation
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.
Arguments
None
Syntax
<IntType> Visible()

VisibleInCamera
Explanation
Query whether this actor is visible for the camera.
Arguments
None
Syntax
<IntType> VisibleInCamera()

VisibleInIDL
Explanation
Query whether this actor emits indirect light.
Arguments
None
Syntax
<IntType> VisibleInIDL()

VisibleInReflections
Explanation
Query whether this actor is visible in reflections.
Arguments
None
Syntax
<IntType> VisibleInReflections()

VisibleInRender
Explanation
Query whether this actor is visible in renders.
Arguments
None
Syntax
<IntType> VisibleInRender()

Actor Methods
132 Poser 11
PoserPython Methods Manual

WeldGoalActors
Explanation
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.
Arguments
None
Syntax
<ActorType List> WeldGoalActors()

WeldGoals
Explanation
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 actor’s
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 -1’s.
Arguments
None
Syntax
<List of IntType Lists> WeldGoals()

WorldDisplacement
Explanation
Get a tuple comprising the World displacement for this actor.
Arguments
None
Syntax
(<FloatType> tx, <FloatType> ty, <FloatType> tz) WorldDisplacement()

WorldMatrix :
Explanation
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.
Arguments
None
Syntax
<FloatType 4x4 Tuple> WorldMatrix()

WorldQuaternion
Explanation
Get a tuple comprising the quaternion world rotation for this actor.

Actor Methods
133 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
(<FloatType> qw, <FloatType> qx, <FloatType> qy, <FloatType> qz )
WorldQuaternion()

ZeroMorphs
Explanation
Get a list of zero morphs.
Arguments
None
Syntax
<StringType list> ZeroMorphs()

Zones
Explanation
If the actor is a zone, this method returns the list of zones.
Arguments
None
Syntax
<ActorType List> ActorZones()

Figure Methods

Actor
Explanation
Get an actor, given its name. This is the name given in Poser’s GUI pull-down
menus.
Arguments
Enter a valid actor name using the Poser external name.
Syntax
<ActorType> Actor(<StringType> name)
Example
fig.Actor(“LeftForearm”)

ActorByInternalName
Explanation
Get an actor, given its internal name. This is a unique identifying string stored
internally by Poser.
Arguments
Enter a valid internal name.
Syntax
<ActorType> Actor(<StringType> name)

Figure Methods
134 Poser 11
PoserPython Methods Manual

Example
fig.ActorByInternalName(“LeftForearm”)

Actors
Explanation
Get a list of actor objects comprising this figure.
Arguments
None
Syntax
<ActorType List> Actors()

ApplyMotionRig
Explanation
Apply the motion rig to the figure.
Arguments
None
Syntax
<NoneType>ApplyMotionRig(<MotionRigType> motionRig)

AutoGroupActor
Explanation
Create geometry groups on a given actor automatically based on the groups of
this figure.
Arguments
Pass the actor that you want to auto group.
Syntax
<NoneType> AutoGroupActor(<ActorType> actor)

CheckFigureMagnets
Explanation
Check magnets attached to a Figure.
Arguments
None
Syntax
<NoneType> CheckFigureMagnets()

ClearStartupScript
Explanation
Specify that no Python script is to be associated with this figure.
Arguments
None
Syntax
<NoneType> ClearStartupScript()

Figure Methods
135 Poser 11
PoserPython Methods Manual

ConformTarget
Explanation
Return the figure whose pose this figure is set to conform to.
Arguments
None
Syntax
<FigureType> ConformTarget()

ConformTo
Explanation
Pose a specified figure to match the pose of the currently selected figure. Note:
This method is not officially supported by Smith Micro Software, and we make no
guarantees as to its functionality or its future availability. We recommend that
you use the SetConformTarget method instead.
Arguments
Enter the name of the figure you wish to pose.
Syntax
<NoneType> ConformTo(<FigureType> conformee)

ConvertToUniversalPose
Explanation
Convert to Universal Pose for the current figure.
Arguments
None.
Syntax
<NoneType> ConvertToUniversalPose()

CopyJointParmsFrom
Explanation
Copy the joint setup from a different figure to this figure.
Arguments
Pass the figure that you want to use as the source of the joint setup.
Syntax
<NoneType> CopyJointParmsFrom(<FigureType> figure),{<IntType>
searchAllWeightMaps}

CreateFullBodyMorph
Explanation
Create a new full body morph for the specified figure.
Arguments
Enter the name of the figure for which you want to create the full body morph.
Syntax
<NoneType> CreateFullBodyMorph(<StringType> name)

Figure Methods
136 Poser 11
PoserPython Methods Manual

CustomData
Explanation
Get custom data associated with this figure. Returns None if no data exists for
that key.
Arguments
Enter the key for the figure.
Syntax
<StringType>CustomData(<StringType>key)

Delete
Explanation
Delete this figure from the scene.
Arguments
None
Syntax
<NoneType> Delete()

DisplayStyle
Explanation
Get the interactive display style for this figure. Typical return values correspond to
poser member variable constants (such as poser.kDisplayCodeWIREFRAME).
Arguments
None
Syntax
<IntType> DisplayStyle()

DropToFloor
Explanation
Lower the figure (along the Y-axis) until it just touches the floor (y=0).
Arguments
None
Syntax
<NoneType> DropToFloor()

FigureMeasure
Explanation
Measures hip height and feet distance.
Arguments
None
Syntax
<NoneType> FigureMeasure()

Figure Methods
137 Poser 11
PoserPython Methods Manual

FollowOriginsWhenConforming
Explanation
Get the status of whether or not to follow origins when conforming this figure.
Arguments
None
Syntax
<IntType> FollowOriginsWhenConforming()

GeomFileName
Explanation
Returns the filename of the geometry being used by the current actor, if any.
Arguments
None
Syntax
<StringType> GeomFileName()

IkNames
Explanation
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().
Arguments
None
Syntax
<StringType list> IkNames()

IkStatus
Explanation
Get the status of inverse kinematics for the specified IK chain index.
Arguments
Enter an index between 0 and figure.NumIkChains()
Syntax
<IntType> IkStatus(<IntType> whichLimb)
Example
leftLegOn = figure.IkStatus(0)

IncludeMorphsWhenConforming
Explanation
Get the status of whether or not to include morphs when conforming this figure.
Arguments
None
Syntax
<IntType> IncludeMorphsWhenConforming()

Figure Methods
138 Poser 11
PoserPython Methods Manual

IncludeScalesWhenConforming
Explanation
Get the status of whether or not to include scales when conforming this figure.
Arguments
None
Syntax
<IntType> IncludeScalesWhenConforming()

IncludeTranslationsWhenConforming
Explanation
Get the status of whether or not to include translations when conforming this
figure.
Arguments
None
Syntax
<IntType> IncludeTranslationsWhenConforming()

InternalName
Explanation
Get the internal name for the figure. This is a unique identifying string stored
internally by Poser.
Arguments
None
Syntax
<StringType> InternalName()

MatchEndpointsWhenConforming
Explanation
Get the status of whether or not to match end points when conforming this
figure.
Arguments
None
Syntax
<IntType> MatchEndpointsWhenConforming()

Material
Explanation
Get a material object by its name. String argument should typically be a
name displayed in the Poser GUI material pulldown menu (e.g. “skin”). The call
searches all materials available to this figure.
Arguments
None
Syntax
<MaterialType> Material(<StringType> name)

Figure Methods
139 Poser 11
PoserPython Methods Manual

Materials
Explanation
Get a list of material objects available to this figure.
Arguments
None
Syntax
<MaterialType List> Materials()

Memorize
Explanation
Set the figure’s default parameter values to the current values so that the figure
can be reset to this pose later (See figure.Reset()).
Arguments
None
Syntax
<NoneType> Memorize()

Name
Explanation
Get the figure’s external name. This is the name given in Poser’s GUI pull-down
menus.
Arguments
None
Syntax
<StringType> Name()

NumIkChains
Explanation
Get the number of inverse kinematics chains attached to this figure..
Arguments
None
Syntax
<IntType> NumIkChains()

NumbSubdivLevels
Explanation
Get the number of subdivision levels for this figure.
Arguments
None
Syntax
<IntType>NumbSubdivLevels()

Figure Methods
140 Poser 11
PoserPython Methods Manual

NumbSubdivRenderLevels
Explanation
Get the number of subdivision levels for this figure.
Arguments
None
Syntax
<IntType>NumbSubdivRenderLevels()

ParentActor
Explanation
Get the parent actor of the figure. Initially, the parent of a figure is typically the
“Body” actor.
Arguments
None
Syntax
<ActorType> ParentActor()

Reset
Explanation
Reset figure to default or last memorized pose. (See figure.Memorize().
Arguments
None
Syntax
<NoneType> Reset()

Restore
Explanation
Restores the figure in a more complete fashion than Figure.Reset(). Figure.
Restore() works exactly as Edit > Restore > Figure. Will perform additional checks,
such as verifying whether Setup is active.
Arguments
None
Syntax
<NoneType> Restore()

SetConformTarget
Explanation
Pose this figure to match the specified figure’s pose.
Arguments
Enter the figure to conform to.
Syntax
<NoneType> SetConformTarget(<FigureType> conformee)

Figure Methods
141 Poser 11
PoserPython Methods Manual

Example
SetConformTarget(Figure1)

SetCustomData
Explanation
Set custom data associated with this figure. This data will always be saved with a
scene file.
Arguments
The additional flags can be set to 1 to make this data also be included in
material sets and/or poses. Passing None as value will clear the custom data for
that key.
Syntax
<NoneType>SetCustomData(<StringType>key, <StringType> value, <IntType>
storeWithPoses, <IntType> storeWithMaterials)

SetDisplayStyle
Explanation
Set display style of the figure.
Arguments
Enter a valid display code.
Syntax
<NoneType> SetDisplayStyle(<IntType> displayCode)
Example
fig.SetDIsplayStyle(poser.kDIsplayCodeFLATLINED)

SetFollowOriginsWhenConforming
Explanation
Set the status of whether or not to follow origins when conforming this figure.
Arguments
Enter a value specifying the status (0 for off, 1 for on).
Syntax
<NoneType> SetFollowOriginsWhenConforming(<IntType> on)

SetIkStatus
Explanation
Set the status of inverse kinematics for the specified IK chain index.
Arguments
Enter an index between 0 and figure.NumIkChains(), as well as a value specifying
the status (0 for off, 1 for on).
Syntax
<NoneType> SetIkStatus(<IntType> whichLimb, <IntType> on)
Example
figure.SetIkStatus(0, 1)

Figure Methods
142 Poser 11
PoserPython Methods Manual

SetIncludeMorphsWhenConforming
Explanation
Set the status of whether or not to include morphs when conforming this figure.
Arguments
Enter a value specifying the status (0 for off, 1 for on).
Syntax
<NoneType> SetIncludeMorphsWhenConforming(<IntType> on)

SetIncludeScalesWhenConforming
Explanation
Set the status of whether or not to include scales when conforming this figure.
Arguments
Enter a value specifying the status (0 for off, 1 for on).
Syntax
<NoneType> SetIncludeScalesWhenConforming(<IntType> on)

SetIncludeTranslationsWhenConforming
Explanation
Set the status of whether or not to include translations when conforming this
figure.
Arguments
Enter a value specifying the status (0 for off, 1 for on).
Syntax
<<NoneType> SetIncludeTranslationsWhenConforming(<IntType> on)

SetMatchEndpointsWhenConforming
Explanation
Set the status of whether or not to match end points when conforming this figure.
Arguments
Enter a value specifying the status (0 for off, 1 for on).
Syntax
<NoneType> SetMatchEndpointsWhenConforming(<IntType> on)

SetMeAsStartupScript
Explanation
Specify the current script as the Python script associated with the current Poser
doc and executed on startup when the document is re-opened.
Arguments
None
Syntax
fig.SetMeAsStartupScript()

Figure Methods
143 Poser 11
PoserPython Methods Manual

SetName
Explanation
Set the (external) name for the figure. This is the name given in Poser’s GUI
pulldown menus.
Arguments
Enter the external name for the figure as a string.
Syntax
<NoneType> SetName(<StringType> name)

SetNumbSubdivLevels
Explanation
Set the number of subdivision levels for this figure.
Arguments
none
Syntax
<NoneType>SetNumbSubdivLevels(<IntType>)

SetNumbSubdivRenderLevels
Explanation
Set the number of subdivision levels for this figure.
Arguments
none
Syntax
<NoneType>SetNumbSubdivRenderLevels(<IntType>)

SetOnOff
Explanation
Hide/show the figure. A value of 1 corresponds to “on” while a value of 0
corresponds to “off”
Arguments
Enter 1 to toggle the current figure visible, or 0 to toggle it invisible.
Syntax
<NoneType> SetOnOff(<IntType> on)
Example
fig.SetOnOff(1)

SetParentActor
Explanation
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.
Arguments
Enter an actor which is to become the new parent of the figure.

Figure Methods
144 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SetParentActor(<ActorType> newParent)
Example
fig.SetParentActor(someActor)

SetSkinType
Explanation
Change the skinning method of the figure. 0 is traditional skinning, 1 is Simple
Bones Single Skin - Interoperable, 2 is Reserved for Future, 3 is Poser Unimesh.
Arguments
Enter value of desired skinning type.
Syntax
<NoneType> SetSkinType(<IntType> on)

SetStartupScript
Explanation
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).
Arguments
Enter the complete path and file name.
Syntax
<NoneType> SetStartupScript(<StringType> filePath)
Example
fig.SetStartupScript(“Runtime\Python\script.py”)

SetVisible
Explanation
Set the display status of the figure in the scene.
Arguments
Enter 1 to display the figure, and 0 to turn figure display off.
Syntax
<NoneType> SetVisible(<IntType> visible)

SkinType
Explanation
Get the skinning type of the figure. 0 is traditional skinning, 1 is interop, 2 is
Reserved for Future, 3 is Poser Unimesh.
Arguments
none
Syntax
<IntType> SkinType()

Figure Methods
145 Poser 11
PoserPython Methods Manual

StartupScript
Explanation
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).
Arguments
None
Syntax
<StringType> StartupScript()

StraightenBody
Explanation
Straighten the figure’s torso area.
Arguments
None
Syntax
<NoneType> StraightenBody()

StripRig
Explanation
Strips all morph and magnet dependencies from rig.
Arguments
None
Syntax
<NoneType> StripRig()

SubdivGeometry
Explanation
Get the subdivided geometry for the figure. The returned geometry object
can then be queried for vertex, set, or polygon information. The number of
subdivisons can be passed as an optional paraemter - if the parameter is missing
or negative, the geometry will be subdivided to NumbSubdivRenderLevels(). It is
a copy of the geometry, any changes to it will not affect the figure.
Arguments
None
Syntax
<GeomType> SubdivGeometry({<IntType> levels})

SwapBottom
Explanation
Swap the orientations of the bottom left and bottom right body parts.
Arguments
None

Figure Methods
146 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SwapBottom()

SwapTop
Explanation
Swap the orientations of the top left and top right body parts.
Arguments
None
Syntax
<NoneType> SwapTop()

SymmetryBotLeftToRight
Explanation
Copy the bottom left side parameters of the figure to the bottom right side.
Arguments
Defaults to 0. Enter a value of 1 to specify that the joints should be copied.
Syntax
<NoneType> SymmetryBotLeftToRight({<IntType> copyJoints})
Example
fig.SymmetryBotLeftToRight(1)

SymmetryBotRightToLeft
Explanation
Copy the bottom left side parameters of the figure to the bottom right side.
Arguments
Defaults to 0. Enter a value of 1 to specify that the joints should be copied.
Syntax
<NoneType> SymmetryBotRightToLeft({<IntType> copyJoints})
Example
fig.SymmetryBotRightToLeft(1)

SymmetryLeftToRight
Explanation
Copy the left side parameters of the figure to the right side.
Arguments
Defaults to 0. Enter a value of 1 to specify that the joints should be copied.
Syntax
<NoneType> SymmmetryLeftToRight({<IntType> copyJoints})
Example
fig.SymmetryLeftToRight(1)

Figure Methods
147 Poser 11
PoserPython Methods Manual

SymmetryRightToLeft
Explanation
Copy the right side parameters of the figure to the left side.
Arguments
Defaults to 0. Enter a value of 1 to specify that the joints should be copied.
Syntax
<NoneType> SymmmetryRightToLeft({<IntType> copyJoints})
Example
fig.SymmetryRightToLeft(1)

SymmetryTopLeftToRight
Explanation
Copy the top left side parameters of the figure to the top right side.
Arguments
Defaults to 0. Enter a value of 1 to specify that the joints should be copied.
Syntax
<NoneType> SymmetryTopLeftToRight({<IntType> copyJoints})
Example
fig.SymmetryTopLeftToRight(1)

SymmetryTopRightToLeft
Explanation
Copy the top left side parameters of the figure to the top right side.
Arguments
Defaults to 0. Enter a value of 1 to specify that the joints should be copied.
Syntax
<NoneType> SymmetryTopRightToLeft({<IntType> copyJoints})
Example
fig.SymmetryTopRightToLeft(1)

UnimeshInfo
Explanation
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
per-actor-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.
Arguments
None
Syntax
(<GeomType>, <actor-list>, <per-actor-vertex-info-list>) UnimeshInfo()
Example
Click the GeomMods button and look for UnimeshDemo sample script.

Figure Methods
148 Poser 11
PoserPython Methods Manual

Visible
Explanation
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.
Arguments
None
Syntax
<IntType> Visible()

Material Methods
NOTE: Numeric values for Bump and Displacement height are
displayed in Python based on Poser native units. If you switch the
display unit preference (General Preference > Interface > Display
> Units) to Poser Native Units, the values returned from Python will
match the values you see in the UI. One Poser Native Unit is the
equivalent of 8.6 feet, or 262.128 centimeters.

AmbientColor
Explanation
Get the material’s ambient color in the format RGB (values between 0.0 and 1.0).
Arguments
None
Syntax
(<FloatType> r, <FloatType> g, <FloatType> b) AmbientColor()

AmbientMapFileName
Explanation
Get the material ambient-map filename.
Arguments
None
Syntax
<StringType> TextureMapFileName()

BumpMapFileName
Explanation
Get the material’s bump map filename.
Arguments
None
Syntax
<StringType> BumpMapFileName()

Material Methods
149 Poser 11
PoserPython Methods Manual

BumpStrength
Explanation
Get the material’s bump strength value.
Arguments
None
Syntax
<FloatType> BumpStrength()

CreateLayer
Explanation
Create new layer.
Arguments

Syntax
<NoneType> CreateLayer(<StringType> name)

DeleteLayer
Explanation
Delete existing layer.
Arguments
None
Syntax
<NoneType> DeleteLayer(<IntType> index)

DiffuseColor
Explanation
Get the material’s diffuse color in the format RGB (values between 0.0 to 1.0).
Arguments
None
Syntax
(<FloatType> r, <FloatType> g, <FloatType> b) DiffuseColor()

ExtName
Explanation
Get the external name for the material.
Arguments
None
Syntax
<StringType> ExtName()

Material Methods
150 Poser 11
PoserPython Methods Manual

Layer
Explanation
Get material at index.
Arguments

Syntax
<MaterialLayerType> Layer(<IntType> layerindex)

LayerByExtName
Explanation
Get material with external name.
Arguments

Syntax
<MaterialLayerType> LayerByExtName(<StringType> name)

LayerByName
Explanation
Get material with name.
Arguments

Syntax
<MaterialLayerType> LayerByName(<StringType> name)

LayerExtName
Explanation
Get the material’s layer’s shader tree’s name (external).
Arguments

Syntax
<StringType> LayerExtName(<IntType> layer)

LayerName
Explanation
Get the material’s layer’s shader tree’s name (internal).
Arguments

Syntax
<StringType> LayerName(<IntType> layer)

Material Methods
151 Poser 11
PoserPython Methods Manual

LayerShaderTree
Explanation
Get the material’s layer’s shader tree.
Arguments

Syntax
<ShaderTreeType> LayerShaderTree(<IntType> layer)

LayerShaderTreeHash
Explanation
Get the material’s layer’s shader tree’s hash.
Arguments

Syntax
<StringType> LayerShaderTreeHash(<IntType> layer)

Layers
Explanation
Get a list of all layers in material.
Arguments

Syntax
<ListType> Layers()

LoadMaterialSet
Explanation
Load a material from the Library.
Arguments
Specify the name of the material you wish to load.
Syntax
<NoneType> LoadMaterialSet(<StringType> name)

Name
Explanation
Get the material’s internal name.
Arguments
None
Syntax
<StringType> Name()

Material Methods
152 Poser 11
PoserPython Methods Manual

Ns
Explanation
Get the material’s 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.
Arguments
None
Syntax
<FloatType> Ns()

NumLayers
Explanation
Get the number of layers for this material.
Arguments
None
Syntax
<IntType> NumLayers()

ReflectionColor
Explanation
Get the material’s reflection color in the format RGB (values from 0.0 to 1.0).
Arguments
None
Syntax
(<FloatType> r, <FloatType> g, <FloatType> b) ReflectionColor()

ReflectionMapFileName
Explanation
Get the material’s reflection map filename.
Arguments
None
Syntax
<StringType> ReflectionMapFileName()

ReflectionStrength
Explanation
Get the material’s reflection strength value.
Arguments
None
Syntax
<FloatType> ReflectionStrength()

Material Methods
153 Poser 11
PoserPython Methods Manual

SaveMaterialSet
Explanation
Save this material to the Library.
Arguments
Specify the name of the material you wish to save.
Syntax
<NoneType> SaveMaterialSet(<StringType> name)

Selected
Explanation
Query whether this material is selected. Use material selection in conjunction
with the Actor. See the SaveMaterialCollection method in the Actor Methods
section.
Arguments
None
Syntax
<IntType> Selected()

SetAmbientColor
Explanation
Set the material’s ambient color.
Arguments
Enter R, G, and B values between 0.0 and 1.0.
Syntax
<NoneType> SetAmbientColor(<FloatType> r, <FloatType> g, <FloatType> b)

SetAmbientMapFileName
Explanation
Set the material ambient-map filename.
Arguments
none
Syntax
<NoneType> SetTextureMapFileName(<StringType> filePath)

SetBumpMapFileName
Explanation
Set the material’s bump map filename.
Arguments
Enter a valid path and filename.
Syntax
<NoneType> SetBumpMapFileName(<StringType> filePath)
Example
mat.SetBumpMapFilename(“E:\Materials\Stone1.bmp”)

Material Methods
154 Poser 11
PoserPython Methods Manual

SetBumpStrength
Explanation
Set the material bump strength to a specific value.
Arguments
Enter a value between –1.0 and 1.0.
Syntax
<FloatType> SetBumpStrength(<FloatType> value)
Example
mat.SetBumpStrength(0.5)

SetDiffuseColor
Explanation
Set the material’s diffuse color.
Arguments
• 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> SetDiffuseColor(<FloatType> r, <FloatType> g, <FloatType> b)
Example
mat.SetDiffuseColor(0.46,0.57,0.33)

SetNs
Explanation
Set the material’s 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 vice-versa.
Arguments
Enter an exponent value.
Syntax
<FloatType> SetNs(<FloatType> value)
Example
mat.SetNs(0.5)

SetReflectionColor
Explanation
Set the material’s reflection color.
Arguments
• 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)
Example
mat.SetReflectionColor(0.46,0.57,0.33)

Material Methods
155 Poser 11
PoserPython Methods Manual

SetReflectionMapFileName
Explanation
Set the material’s reflection map filename.
Arguments
Enter a valid path and file name.
Syntax
<NoneType> SetReflectionMapFileName(<StringType> filePath)
Example
mat.SetReflectionMapStrength(“C:\My Documents\myrefmap.bmp”)

SetReflectionStrength
Explanation
Set the material’s reflection strength to a specific value.
Arguments
Enter a value between –1.0 and 1.0.
Syntax
<FloatType> SetReflectionStrength(<FloatType> value)
Example
mat.SetReflectionStrength(0.5)

SetSelected
Explanation
Selects or deselects the material for inclusion in a material collection. A value
of 1 selects the material, a value of 0 deselects. Use material selection in
conjunction with the Actor. See the SaveMaterialCollection method in the Actor
Methods section.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetSelected(<IntType> selected)

SetSpecularColor
Explanation
Set the material’s specular highlight color.
Arguments
• 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> SetSpecularColor(<FloatType> r, <FloatType> g, <FloatType> b)
Example
mat.SetSpecularColor(0.46,0.57,0.33)

Material Methods
156 Poser 11
PoserPython Methods Manual

SetTextureColor
Explanation
Set the material texture color in the format RBG.
Arguments
• 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> SetTextureColor(<FloatType> r, <FloatType> g, <FloatType> b,
<FloatType> )
Example
mat.SetTextureColor(0.46,0.57,0.33)

SetTextureMapFileName
Explanation
Set the material’s texture map filename.
Arguments
Enter the path and file name.
Syntax
<NoneType> SetTextureMapFileName(<StringType> filePath)
Example
mat.SetTexttureMapFileName(“C:\Files\Textures\ tex1.bmp”)

SetTransparencyExpo
Explanation
Set the material’s 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.
Arguments
Enter a value between 0.0 and 10.0.
Syntax
<FloatType> SetTransparencyExpo(<FloatType> value)
Example
mat.SetTransparencyExpo(5.0).

SetTransparencyMapFileName
Explanation
Set the material’s transparency map filename.
Arguments
Enter the path and filename.
Syntax
<NoneType> SetTransparencyMapFileName(<StringType> filePath)
Example
mat.SetTransparencyMapFileName(“C:\Files\ trans1.bmp”)

Material Methods
157 Poser 11
PoserPython Methods Manual

SetTransparencyMax :
Explanation
Set the material’s 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.
Arguments
Enter a value between 0.0 and 1.0.
Syntax
<FloatType> SetTransparencyMax(<FloatType> value)
Example
mat.SetTransparencyMax(0.5)

SetTransparencyMin
Explanation
Set the material’s 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.
Arguments
Enter a value between 0.0 and 1.0.
Syntax
<FloatType> SetTransparencyMin(<FloatType> value)
Example
mat.SetTransparencyMin(0.5)

ShaderTree
Explanation
Get the material’s shader tree.
Arguments
None
Syntax
<ShaderTreeType> ShaderTree()

ShaderTreeHash
Explanation
Get the material’s shader tree’s hash.
Arguments
None
Syntax
<StringType> ShaderTreeHash()

SpecularColor
Explanation
Get the material’s specular highlight color in the format RGB (values between 0.0

Material Methods
158 Poser 11
PoserPython Methods Manual

and 1.0)
Arguments
None
Syntax
(<FloatType> r, <FloatType> g, <FloatType> b) SpecularColor()

TextureColor
Explanation
Get the material’s texture color in the format RG (values from 0.0 and 1.0).
Arguments
None
Syntax
(<FloatType> r, <FloatType> g, <FloatType> b) TextureColor()

TextureMapFileName
Explanation
Get the material’s texture map filename.
Arguments
None
Syntax
<StringType> TextureMapFileName()

TransparencyExpo
Explanation
Get the material’s tExpo value. The TransparencyExpo value determines the rate
at which the transparency becomes opaque on the edges of an object.
Arguments
None
Syntax
<FloatType> TransparencyExpo()

TransparencyMapFileName
Explanation
Get the material’s transparency map filename.
Arguments
None
Syntax
<StringType> TransparencyMapFileName()

TransparencyMax
Explanation
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.

Material Methods
159 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<FloatType> TransparencyMax()

TransparencyMin
Explanation
Get the tMin value for the material. A high TransparencyMin value makes the
object very transparent on its edges.
Arguments
None
Syntax
<FloatType> TransparencyMin()

Material Layer Methods

ExtName
Explanation
Get the name(external only) for the materialLayer.
Arguments
None
Syntax
<StringType> ExtName()

Name
Explanation
Get the name(internal only) for the materialLayer.
Arguments
None
Syntax
<StringType> Name()

ShaderTree
Explanation
Get the material layer’s shader tree.
Arguments
None
Syntax
<ShaderTreeType> ShaderTree()

Material Layer Methods

160 Poser 11
PoserPython Methods Manual

ShaderTreeHash
Explanation
Get the material layer’s shader tree’s hash.
Arguments
None
Syntax
<StringType> ShaderTreeHash()

Parameter Methods

Actor
Explanation
Return the actor which owns this parm.
Arguments
None
Syntax
<ActorType> Actor()

AddKeyFrame
Explanation
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.
Arguments
Enter a valid frame number.
Syntax
<NoneType> AddKeyFrame({<IntType> frame})
Example
AddKeyFrame(81)

AddValueOperation
Explanation
Add a value operation of the specified type to this parameter.
The source parm is a different parameter, that serves as key when
valueOpType is kValueOpTypeCodeKEY or as operand in a math
operation for kValueOpTypeCodeDELTAADD, kValueOpCodeADD,
kValueOpTypeCodeDIVIDEINTO, kValueOpTypeCodeMINUS,
kValueOpTypeCodePLUS and kValueOpTypeCodeTIMES.
Arguments
Enter one of the ValueOp codes above as valueOpType, specifying what type of
value operation you intend to add. Pass the parameter that should serve as key
or operand as sourceParm.
Syntax
<NoneType> AddValueOperation(<IntType> valueOpType, <ParmType>
sourceParm)

Parameter Methods
161 Poser 11
PoserPython Methods Manual

AddZone
Explanation
Add a zone of the specified type to this parameter. Supported types are
kZoneTypeCodeWEIGHTMAP (Pro Only), kZoneTypeCodeMERGEDWEIGHTMAP
(Pro Only), kZoneTypeCodeSPHERE or kZoneTypeCodeCAPSULE.
Arguments
Enter one of the codes above as zoneType, specifying what type of zone you
intend to add.
Syntax
<NoneType> AddZone(<IntType> zoneType)

ApplyLimits
Explanation
Apply minimum and maximum limits to parameter.
Arguments
None
Syntax
<NoneType> ApplyLimits()

ClearUpdateCallback
Explanation
Clear update callback for calculating this parameter value if it is set.
Arguments
None
Syntax
<NoneType> ClearUpdateCallback()

ConstantAtFrame
Explanation
Query whether or not the given frame is within a constant range. If no frame is
specified, the default frame is the current frame
Arguments
Optionally, enter a valid frame number.
Syntax
<IntType> ConstantAtFrame({<IntType> frame})
Example
parm.ConstantAtFrame(12)

DeleteKeyFrame
Explanation
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.
Arguments
Enter a valid frame number.

Parameter Methods
162 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> DeleteKeyFrame({<IntType> frame})
Example
parm.DeleteKeyFrame(30)

DeleteValueOperation
Explanation
Deletes the value operation at the given index.
Arguments
Enter a valid index number.
Syntax
<NoneType> DeleteValueOperation(<IntType> index)

ForceLimits
Explanation
Query whether or not this parameter enforces its limits. Returns 1 if it is enforced
and 0 if it is not.
Arguments
none
Syntax
<IntType> ForceLimits()

HasKeyAtFrame
Explanation
Query if this parameter has a key frame at a given frame.
Arguments
none
Syntax
<IntType> HasKeyAtFrame(<IntType> frame)

Hidden
Explanation
Query whether or not the current parameter is hidden from the user interface
(UI). Returns 1 if hidden, 0 if visible.
Arguments
None
Syntax
<IntType> Hidden()

InitValue
Explanation
Get the init value of the parameter.

Parameter Methods
163 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<FloatType> InitValue()

InternalName
Explanation
Get the parameter’s internal name.
Arguments
None
Syntax
<StringType> InternalName()

IsMorphTarget
Explanation
Query whether or not this parameter is a morph target parameter. Returns 1 if it is
and 0 if it is not.
Arguments
None
Syntax
<IntType> IsMorphTargetParamter()

IsValueParameter
Explanation
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.
Arguments
None
Syntax
<IntType> IsValueParamter()

LinearAtFrame
Explanation
Query whether or not the given frame is within a linear range. If no frame is
specified, the default frame is the current frame.
Arguments
Optionally, enter a valid frame number.
Syntax
<IntType> LinearAtFrame({<IntType> frame})
Example
parm.LinearAtFrame(12)

Parameter Methods
164 Poser 11
PoserPython Methods Manual

MaxValue
Explanation
Get the current parameter’s maximum value.
Arguments
None
Syntax
<FloatType> MaxValue()

MinValue
Explanation
Get the parameter’s current minimum value.
Arguments
None
Syntax
<FloatType> MinValue()

MorphTargetDelta
Explanation
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.
Arguments
Enter X, Y, and Z delta values and the vertex index number.
Syntax
(<FloatType> deltaX, <FloatType> deltaY, <FloatType> deltaZ)
MorphTargetDelta(<IntType> vertexIndex)

Name
Explanation
Get the parameter’s external name.
Arguments
None
Syntax
<StringType> Name()

NextKeyFrame
Explanation
Get the next frame in which the parameter has a key frame set.
Arguments
None
Syntax
<IntType> NextKeyFrame()

Parameter Methods
165 Poser 11
PoserPython Methods Manual

NumMorphTargetDeltas
Explanation
If this parameter is a morph target parameter, return the number of morph target
“delta” associated with the parameter.
Arguments
None
Syntax
<IntType> NumMorphTargetDeltas()

NumValueOperations
Explanation
Returns the number of value operations on this parameter. Return 0 if there are
no value operations on this parameter.
Arguments
None
Syntax
<IntType> NumValueOperations()

PrevKeyFrame
Explanation
Get the previous frame in which the parameter has a key frame set.
Arguments
None
Syntax
<IntType> PrevKeyFrame()

Sensitivity
Explanation
Get the sensitivity of the mouse tracking (on the user interface).
Arguments
None
Syntax
<FloatType> Sensitivity()

SetForceLimits
Explanation
Set if this parameter enforces limits.
Arguments
Call with an argument of 1 to enforce them or call it with an argument of 0 to not
enforce them.
Syntax
<NoneType> SetForceLimits(<IntType> force)

Parameter Methods
166 Poser 11
PoserPython Methods Manual

SetHidden
Explanation
Set the hidden status of this parameter.
Arguments
• 0: Set the parameter as visible.
• 1: Set the parameter as hidden.
Syntax
<NoneType> SetHidden(<IntType> hide)
Example
parm.SetHidden(1)

SetInitValue
Explanation
Set the init value of the parameter.
Arguments
None
Syntax
<FloatType> SetInitValue(<FloatType> value)

SetInternalName
Explanation
Set the parameter’s internal name.
Arguments
None
Syntax
<NoneType> SetInternalName()

SetMaxValue
Explanation
Set the parameter’s maximum value.
Arguments
Enter a valid value for the current parameter.
Syntax
<FloatType> SetMaxValue(<FloatType> value)
Example
parm.SetMaxValue(100.00)

SetMinValue
Explanation
Set the parameter’s minimum value.
Arguments
Enter a valid value for the current parameter.
Syntax
<FloatType> SetMinValue(<FloatType> value)

Parameter Methods
167 Poser 11
PoserPython Methods Manual

Example
parm.SetMinValue(1.35)

SetMorphTargetDelta
Explanation
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.
Arguments
• 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.
Syntax
<NoneType> SetMorphTargetDelta(<IntType> vertexIndex, <FloatType>
deltaX, <FloatType> deltaY, <FloatType> deltaZ)
Example
parm.SetMorphTargetDelta( vertexIndex, 0.12, 0.34, 0.45)

SetName
Explanation
Set the parameter’s external name.
Arguments
Enter a valid name for the current parameter.
Syntax
<NoneType> SetName(<StringType> name)
Example
parm.SetName(“Test1”)

SetRangeConstant
Explanation
Set the given frame range to have constant (step) interpolation between
keyframes. Automatically sets key frames at start and end of specified.
Arguments
Enter valid start and end frame numbers.
Syntax
<NoneType> SetRangeConstant(<IntType> startFrame, <IntType> endFrame)
Example
parm.SetRangeConstant(12,32)

SetRangeLinear
Explanation
Set the given frame range to have linear interpolation between key frames.
Automatically sets key frames at start and end of specified range.

Parameter Methods
168 Poser 11
PoserPython Methods Manual

Arguments
Enter valid start and end frame numbers.
Syntax
<NoneType> SetRangeLinear(<IntType> startFrame, <IntType> endFrame)
Example
parm.SetRangeLinear(12,32)

SetRangeSpline
Explanation
Set the given frame range to have spline interpolation between key frames.
Automatically sets key frames at start and end of specified range.
Arguments
Enter a valid starting and ending frame.
Syntax
<NoneType> SetRangeSpline(<IntType> startFrame, <IntType> endFrame)
Example
parm.SetRangeSpline(10,20)

SetSensitivity
Explanation
Set the sensitivity of the mouse tracking (on the user interface).
Arguments
Enter a sensitivity value (typically between 0 and 1). Values closer to 0 decrease
the sensitivity.
Syntax
<NoneType> SetSensitivity(<FloatType> value)

SetSplineBreak
Explanation
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.
Arguments
Enter a valid frame number. Optionally, add 0 to u-break the spline.
Syntax
<NoneType> SetSplineBreak({<IntType> frame, <IntType> on})
Example
parm.SetSplineBreak(12,0)

SetUpdateCallback
Explanation
Set a per-update callback for calculating this parameter value.

Parameter Methods
169 Poser 11
PoserPython Methods Manual

Arguments
The callback function should take the parameter and the parameters current
value as callbacks.
Syntax
<NoneType> SetUpdateCallback(<FunctionType> newCB, {<Object> cbArgs})
Example
(See sample scripts)

SetValue
Explanation
Set the parameter to a specific value.
Arguments
Enter the desired parameter value.
Syntax
<NoneType> SetValue(<FloatType> value)

SetValueFrame
Explanation
Set the parameter to a specific key frame.
Arguments
Enter the desired key frame number.
Syntax
<NoneType> SetValueFrame(<FloatType> value, <IntType> keyFrame)

SetWantsConform
Explanation
Sets if this parameter wants to auto-conform to a base figure or not.
Arguments
Call with an argument of 0 or 1.
Syntax
SetWantsConform(<IntType> oneOrZero)

SplineAtFrame
Explanation
Query whether or not the given frame is within a spline range. If no frame is
specified, the default frame is the current frame.
Arguments
Optionally, enter a valid frame number.
Syntax
<IntType> SplineAtFrame({<IntType> frame})
Example
parm.SplineAtFrame(32)

Parameter Methods
170 Poser 11
PoserPython Methods Manual

SplineBreakAtFrame
Explanation
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.
Arguments
Enter a valid frame number.
Syntax
<IntType> SplineBreakAtFrame({<IntType> frame})
Example
parm. SplineBreakAtFrame(12)

SplitMorphLeftRight
Explanation
If this parameter is a morph target parameter, split left & right.
Arguments
none
Syntax
<NoneType> SplitMorphLeftRight()
Example

TypeCode
Explanation
Get the type code for this parameter. Type codes are enumerated values, such
as poser.kParmCodeXROT.
Arguments
None
Syntax
<IntType> TypeCode()

UnaffectedValue
Explanation
Get the current value of the parameter.
Arguments
none
Syntax
<FloatType> Value()
Example

Value
Explanation
Get the parameter’s current value.

Parameter Methods
171 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<FloatType> Value()

ValueFrame
Explanation
Get the current value of the parameter at a specific frame.
Arguments
Enter a valid frame number.
Syntax
ValueFrame(<IntType> keyFrame)

ValueOperations
Explanation
Returns the list of value operations on this parameter. Return None if there are no
value operations on this parameter.
Arguments
None
Syntax
<ValueOperationType List> ValueOperations()

WantsConform
Explanation
Query whether or not this parameter wants to auto-conform to a base figure.
Returns 0 or 1.
Arguments
None
Syntax
<IntType> WantsConform()

ValueOp Methods

DeleteKey
Explanation
Deletes the key/value pair at the given index for a key valueOp. Returns 1 if the
key was deleted, returns 0 if no key exists at the given index or the valueOp is not
of type kValueOpTypeCodeKEY.
Arguments
Enter the index of the key you want to delete.
Syntax
<IntType> DeleteKey(<IntType> index)

ValueOp Methods
172 Poser 11
PoserPython Methods Manual

Delta
Explanation
Get the delta value of a deltaAdd value operation. Returns 0 if the value
operation is not of type kValueOpTypeCodeDELTAADD.
Arguments
None
Syntax
<FloatType> Delta()

GetKey
Explanation
Returns a tuple containing the key and value at the given index for a key
valueOp.
Arguments
Enter the index value of the key which value you want to get.
Syntax
(<IntType>, <IntType>) GetKey(<IntType> index)

InsertKey
Explanation
Inserts a key/value pair in this key valueOp. Returns 1 if the key was inserted,
returns 0 if the valueOp is not of type kValueOpTypeCodeKEY.
Arguments
Enter the numerical values of the key value you want to insert, and its value.
Syntax
<IntType> InsertKey(<FloatType> key, <FloatType> value)

NumKeys
Explanation
Get the number of keys of a key value operation. Returns -1 if the value
operation is not of type kValueOpTypeCodeKEY.
Arguments
None
Syntax
<IntType> NumKeys()

Parameter
Explanation
Get the parameter associated with this valueOp.
Arguments
None
Syntax:
<ParmType> Parameter()

ValueOp Methods
173 Poser 11
PoserPython Methods Manual

SetDelta
Explanation
Set the delta value of a deltaAdd value operation.
Arguments
Enter a numerical value for the delta amount to add.
Syntax
<NoneType> SetDelta(<FloatValue> delta)

SetSourceParameter
Explanation
Set the source parameter associated with this value operation.
Arguments:
Pass the parameter that should serve as key or operand as sourceParm.
Syntax
<NoneType> SetSourceParameter(<ParmType> source)

SetStrength
Explanation
Set the strength value of a value operation.
Arguments
none
Syntax
<NoneType> SetStrength(<FloatValue> strength)

SourceParameter
Explanation
Get the source parameter associated with this valueOp.
Arguments
None
Syntax
<ParmType> SourceParameter()

Strength
Explanation
Get the strength value of a value operation.
Arguments
none
Syntax
<FloatType> Strength()

ValueOp Methods
174 Poser 11
PoserPython Methods Manual

Type
Explanation
Get the type of the valueOp.
Arguments
None
Syntax
<IntType> Type()

Geometry Methods

AddGeneralMesh
Explanation
Add a general mesh to existing geometry. Arguments are numerical Python
arrays specifying polygons, sets, and vertices, as well as optionally texture-
polygons, texture-sets, and texture-vertices.
Arguments
Required:
• 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})
Example
See sample scripts.

AddMaterialName
Explanation
Adds a material name to the geometry material name list and returns its index.
Arguments
Enter the name for the new material.
Syntax
<IntType> AddMaterialName(<StringType> name)

Geometry Methods
175 Poser 11
PoserPython Methods Manual

Example
j = geom.AddMaterialName(“Chartreux”)

AddPolygon
Explanation
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.
Arguments
Enter a Numerical array containing the actual positions of the vertices for the
new polygon. Each vertex has an X, Y, and Z component.
Syntax
<PolygonType> AddPolygon(<FloatType nx3 Numeric.Array> vertices)
Example
poly = geom.AddPolygon(newVerts)

AddTriangle
Explanation
Add a triangle to existing geometry by specifying 3 points.
Arguments
Enter a tuple of tuples specifying the vertices of the new triangle to add.
Syntax
<StringType list> Groups()
Example
poly = geom.AddTriangle((1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0,
1.0))

Groups
Explanation
Get the list of group names for this geometry. Groups can be created using the
grouping tool in the Poser GUI.
Arguments
None
Syntax
<StringType list> Groups()

Materials
Explanation
Get a list of material objects of the geometry.
Arguments
None
Syntax
<MaterialType List> Materials()

Geometry Methods
176 Poser 11
PoserPython Methods Manual

Normals
Explanation
Get a list of vertex normals. Each normal is a vertex object.
Arguments
None
Syntax
<VertType List> Normals()

NumMaterials
Explanation
Get the number of materials in the geometry.
Arguments
None
Syntax
<IntType> NumMaterials()

NumNormals
Explanation
Get the number of normals in the geometry.
Arguments
None
Syntax
<IntType> NumNormals()

NumPolygons
Explanation
Get the number of polygons in the geometry.
Arguments
None
Syntax
<IntType> NumPolygons()

NumSets
Explanation
Get the number of sets in the geometry.
Arguments
None
Syntax
<IntType> NumSets()

Geometry Methods
177 Poser 11
PoserPython Methods Manual

NumTexPolygons
Explanation
Get the number of texture polygons in the geometry.
Arguments
None
Syntax
<IntType> NumTexPolygons()

NumTexSets
Explanation
Get the number of texture sets in the geometry.
Arguments
None
Syntax
<IntType> NumTexSets()

NumTexVertices
Explanation
Get the number of texture vertices in the geometry..
Arguments
None
Syntax
<IntType> NumTexVertices()

NumVertices
Explanation
Get the number of vertices in the geometry.
Arguments
None
Syntax
<IntType> NumVertices()

Polygon
Explanation
Get a polygon object by specifying its index.
Arguments
Enter a valid polygon index.
Syntax
<PolygonType> Polygon(<IntType> index)
Example
geom.Polygon(3)

Geometry Methods
178 Poser 11
PoserPython Methods Manual

Polygons
Explanation
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.
Arguments
None
Syntax
<PolygonType List> Polygons()

ReducePolys
Explanation
Returns a copy of the mesh with a reduced polygon count.
Arguments
None
Syntax
<GeomType> ReducePolys(<IntType> numPolygon> )

Sets
Explanation
Get a set list for the geometry. Each set value is an index into the vertex list.
Arguments
None
Syntax
<IntType List> Sets()

TexPolygons
Explanation
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.
Arguments
None
Syntax
<TexPolygonType List> TexPolygons()

TexSets
Explanation
Get a texture set list for the geometry. Each texture set value is an index into the
texture vertex list.
Arguments
None
Syntax
<IntType List> TexSets()

Geometry Methods
179 Poser 11
PoserPython Methods Manual

TexVertices
Explanation
Get a list of texture vertex objects. Each vertex object can be queried for U and
V values.
Arguments
None
Syntax
<TexVertType List> TexVertices()

Vertex
Explanation
Get a (model space) vertex object by specifying its index.
Arguments
Enter the index of the vertex you want to get.
Syntax
<VertType> Vertex(<IntType> index)

Vertices
Explanation
Get a list of vertex objects. Each vertex object can be queried for x,y,z values.
Arguments
None
Syntax
<VertType List> Vertices()

Weld
Explanation
Share similar vertices. This call smoothes objects by homogenizing normals for
coincident vertices.
Arguments
None
Syntax
<NoneType> Weld()

WorldNormals
Explanation
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.
Arguments
None
Syntax
<VertType List> WorldNormals()

Geometry Methods
180 Poser 11
PoserPython Methods Manual

WorldVertex
Explanation
If possible, get a (world space) vertex object by specifying its index. If no world
space data is available, the function will return None.
Arguments
Enter the index of the vertex you want to get.
Syntax
<VertType> WorldVertex(<IntType> index)

WorldVertices
Explanation
Get the vertices of the geometry in world space if possible. If no world space
data is available, the function will return None.
Arguments
None
Syntax
<VertType List> WorldVertices()

Texture Methods

Gamma
Explanation
Get the Gamma value - usual values 1.0 (no correction), 2.2 (standard
correction).
Arguments
None
Syntax
<FloatType> Gamma()

SetGamma
Explanation
Set the Gamma value - usual values 1.0 (no correction), 2.2 (standard
correction), range is 0.2-5. Also sets UseSceneGamma to false (0).
Arguments
None
Syntax
<NoneType> SetGamma(<FloatType> gamma)

UseSceneGamma
Explanation
Query which gamma correction value is being used. Results are 1 for scene
render settings, 0 for custom.

Texture Methods
181 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<IntType> UseSceneGamma()

SetUseSceneGamma
Explanation
Specify which gamma correction value will be used. Use 1 for scene render
settings, 0 for custom.
Arguments
None
Syntax
<NoneType> SetUseSceneGamma(<IntType> useSceneGamma)

Vertex Methods

SetX
Explanation
Set X coordinate.
Arguments
Enter a valid coordinate.
Syntax
<NoneType> SetX(<FloatType> value)
Example
vert.SetX(4.11)

SetY
Explanation
Set Y coordinate.
Arguments
Enter a valid coordinate.
Syntax
<NoneType> SetY(<FloatType> value)
Example
vert.SetY(2.25)

SetZ
Explanation
Set Z coordinate.
Arguments
Enter a valid coordinate.
Syntax
<NoneType> SetZ(<FloatType> value)

Vertex Methods
182 Poser 11
PoserPython Methods Manual

Example
vert.SetZ(6.52)

X
Explanation
Get X coordinate.
Arguments
None
Syntax
<FloatType> X()

Y
Explanation
Get Y coordinate.
Arguments
None
Syntax
<FloatType> Y()

Z
Explanation
Get Z coordinate.
Arguments
None
Syntax
<FloatType> Z()

Polygon Methods

Groups
Explanation
Return a list of groups in which this polygon is included. Groups can be created
using the grouping tool in the Poser GUI.”
Arguments
None
Syntax
<StringType list> Groups()

InGroup
Explanation
Determine if the polygon is in the specified group. Groups can be created using
the grouping tool in the Poser GUI.

Polygon Methods
183 Poser 11
PoserPython Methods Manual

Arguments
Enter a valid group name.
Syntax
<IntType> InGroup(<StringType> groupName)
Example
poly.InGroup(“MyNewGroup”)

IncludeInGroup
Explanation
Include the polygon in the specified group. Groups can be created using the
grouping tool in the Poser GUI.
Arguments
Enter a valid group name.
Syntax
<NoneType> IncludeInGroup(<StringType> groupName)
Example
poly.IncludeInGroup(“MyNewGroup”)

MaterialIndex
Explanation
Get the material index of the element. This is an index into the list of materials of
this geometry object.
Arguments
None
Syntax
<IntType> MaterialIndex()

MaterialName
Explanation
Get the element’s material name.
Arguments
None
Syntax
<StringType> MaterialName()

NumVertices
Explanation
Get the number of vertices in the polygon.
Arguments
None
Syntax
<IntType> NumVertices()

Polygon Methods
184 Poser 11
PoserPython Methods Manual

RemoveFromGroup
Explanation
Remove the polygon from the specified group. Groups can be created using
the grouping tool in the Poser GUI.
Arguments
Enter a valid group name.
Syntax
<NoneType> RemoveFromGroup(<StringType> groupName)
Example
poly.RemoveFromGroup(“MyNewGrouMethod Name

SetMaterialIndex
Explanation
Set the polygon’s material index. This is an index into the list of materials of this
geometry object.
Arguments
Enter the index of the desired material.
Syntax
<NoneType> SetMaterialIndex(<IntType> index)
Example
poly.SetMaterialIndex(3)

SetMaterialName
Explanation
Set the material name of the polygon, returns material index.
Arguments
Enter a name for the polygon’s material.
Syntax
<IntType> SetMaterialName(<StringType> name)
Example
poly.SetMaterialName(“cotton”)

Start
Explanation
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.
Arguments
None
Syntax
<IntType> Start()

Vertices
Explanation
Get a list of vertex objects for the polygon.

Polygon Methods
185 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<VertType List> Vertices()

TexPolygon Methods

NumTexVertices
Explanation
Get the number of texture vertices in the geometry.
Arguments
None
Syntax
<IntType> NumTexVertices()

Start
Explanation
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.
Arguments
None
Syntax
<IntType> Start()

TexVertices
Explanation
Get a list of texture vertex objects for the polygon.
Arguments
None
Syntax
<TexVertType List> TexVertices()

TexVertex Methods

SetU
Explanation
Set U coordinate.
Arguments
Enter a U coordinate.
Syntax
<NoneType> SetU(<FloatType> value)
Geom.SetU(.96)

TexPolygon Methods
186 Poser 11
PoserPython Methods Manual

SetV
Explanation
Set V coordinate.
Arguments
Enter a V coordinate.
Syntax
<NoneType> SetU(<FloatType> value)
Example
geom.SetV(.96)

U
Explanation
Get U coordinate.
Arguments
None
Syntax
<FloatType> U()

V
Explanation
Get V coordinate.
Arguments
None
Syntax
<FloatType> V()

Skin Types

kSkinTypePoser
Explanation

Arguments
None
Syntax

kSkinTypeUnimeshLinear
Explanation

Arguments
None

Skin Types
187 Poser 11
PoserPython Methods Manual

Syntax

kSkinTypeUnimeshPoser
Explanation

Arguments
None
Syntax

Shader Tree Methods

This class of methods was introduced in Poser 6.0.0.

AttachTreeNodes
Explanation
Connect a ShaderNode’s output to another ShaderNode’s input.
Arguments
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).
Syntax
<NoneType> AttachTreeNodes(<ShaderNodeType> node1, <StringType>
parameter, <ShaderNodeType> node2)

CreateNode
Explanation
Create a new ShaderNode.
Arguments
Specify the type of ShaderNode you wish to create.
Syntax
<ShaderNodeType> CreateNode(<StringType> type)

DeleteNode
Explanation
Delete a node from the ShaderTree.
Arguments
Specify the number of the node you wish to delete.
Syntax
<NoneType> DeleteNode(<IntType> i)

Shader Tree Methods

188 Poser 11
PoserPython Methods Manual

DetachTreeNode
Explanation
Detach a node from a specified input on a specified node.
Arguments
Specify the node from which you want to detach (node), and the specific input
on that node from which you are detaching (parameter).
Syntax
<NoneType> DetachTreeNode(<ShaderNodeType> node, <StringType> parameter)

Node
Explanation
Get the node number “ i ” in this ShaderTree.
Arguments
Specify the node number you wish to get.
Syntax
<ShaderNodeType> Node(<IntType> i)

NodeByInternalName
Explanation
Get a ShaderNode by using its internal name.
Arguments
Specify the internal name of the ShaderNode you wish to get.
Syntax
<ShaderNodeType> NodeByInternalName(<StringType> name)

Nodes
Explanation
Get a list of all nodes in this ShaderTree.
Arguments
None
Syntax
<ListType> Nodes()

NumNodes
Explanation
Get the number of nodes in this ShaderTree.
Arguments
None
Syntax
<IntType> NumNodes()

Shader Tree Methods

189 Poser 11
PoserPython Methods Manual

RendererRootNode
Explanation
Get output node for desired renderer.
Arguments
None
Syntax
<ShaderNodeType> RendererRootNode(<EnumType> renderer)

SetRendererRootNode
Explanation
Set output node for desired renderer.
Arguments
None
Syntax
<NoneType> SetRendererRootNode(<ShaderNodeType> node, <EnumType>
renderer)

UpdatePreview
Explanation
Tell Poser that this ShaderTree has been modified.
Arguments
None
Syntax
<NoneType> UpdatePreview()

Shader Node Methods

This class of methods was introduced in Poser 6.0.0.

CompoundData
Explanation
Get a data object providing access to compound-node-specific methods. If this
is not a compound node, the return value will be None
Arguments
None
Syntax
<ShaderNodeCompoundDataType> CompoundData()

ConnectToInput
Explanation
Connect the output of this node to the given input
Arguments
Specify a node input

Shader Node Methods

190 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> ConnectToInput(<ShaderNodeInputType> Input)

Delete
Explanation
Delete this node. (You must not use this ShaderNode object after deleting it.)
Arguments
None
Syntax
<NoneType> Delete()

Input
Explanation
Get an input by means of its index.
Arguments
Enter an input index number.
Syntax
<ShaderNodeInputType> Input(<IntType> Index)

InputByInternalName
Explanation
Get an input by means of its internal name.
Arguments
Enter the internal name of the input you wish to access.
Syntax
<ShaderNodeInputType> InputByInternalName(<StringType> inputName)

Inputs
Explanation
Get a list of all inputs for the current node (the node upon which this method is
called).
Arguments
None
Syntax
<ShaderNodeInputType list> Inputs()

InputsCollapsed
Explanation
Query whether the node’s inputs are collapsed in the UI.
Arguments
None
Syntax
<IntType> InputsCollapsed()

Shader Node Methods

191 Poser 11
PoserPython Methods Manual

InternalName
Explanation
Get the internal name for the node.
Arguments
None
Syntax
<StringType> InternalName()

IsRoot
Explanation
Get is this node root type node.
Arguments
None
Syntax
<BoolType> IsRoot()

Location
Explanation
Get the UI position of this node in pixels.
Arguments
None
Syntax
(<IntType> x, <IntType> y) Location()

Name
Explanation
Get the (external) name of the node.
Arguments
None
Syntax
<StringType> Name()

NumInputs
Explanation
Get the number of this ShaderNode’s inputs.
Arguments
None
Syntax
<IntType> NumInputs()

Shader Node Methods

192 Poser 11
PoserPython Methods Manual

NumOutputs
Explanation
Get the number of outputs of this ShaderNode.
Arguments
None
Syntax
<IntType> NumOutputs()

Output
Explanation
Get an output by its index.
Arguments
None
Syntax
<ShaderNodeOutputType> Output(<IntType> Index)

OutputByInternalName
Explanation
Get an output by its internal name.
Arguments
Enter the internal name of the output you wish to access.
Syntax
<ShaderNodeOutputType> OutputByInternalName(<StringType> outputName)

Outputs
Explanation
Get a list of all outputs for the current node (the node upon which this method is
called).
Arguments
None
Syntax
<ShaderNodeOutputType list> Outputs()

PreviewCollapsed
Explanation
Query whether the node’s preview is collapsed in the UI.
Arguments
None
Syntax
<IntType> PreviewCollapsed()

Shader Node Methods

193 Poser 11
PoserPython Methods Manual

SelectedOutput
Explanation
Get which output is the selected one. This determines which preview is shown in
the node preview pane.
Arguments
None
Syntax
<IntType> SelectedOutput()

SetInputsCollapsed
Explanation
Set whether the node’s inputs are collapsed in the UI.
Arguments
Enter 1 to collapse inputs, and 0 to disable input collapse.
Syntax
<NoneType> SetInputsCollapsed(<IntType> Collapsed)

SetLocation
Explanation
Set the UI position of this node in pixels.
Arguments
The x and y Arguments specify the coordinates of the node location on the
Material palette.
Syntax
<NoneType> SetLocation(<IntType> x, <IntType> y)

SetName
Explanation
Set the (external) name of the node.
Arguments
Enter a string for the name
Syntax
<NoneType> SetName(<StringType> Name)

SetPreviewCollapsed
Explanation
Set whether the preview is collapsed in the UI.
Arguments
Enter 1 to collapse the preview, or 0 to disable preview collapse.
Syntax
<NoneType> SetPreviewCollapsed(<IntType> Collapsed)

Shader Node Methods

194 Poser 11
PoserPython Methods Manual

SetSelectedOutput
Explanation
Set which output is the selected one. This determines which preview is shown in
the node preview pane.
Arguments
none
Syntax
<NoneType> SetSelectedOutput(<IntType> outputIndex)

Type
Explanation
Get the Type of this node.
Arguments
None
Syntax
<StringType> Type()

Shader Node Input Methods

This class of methods was introduced in Poser 6.0.0.

Animated
Explanation
Returns 1 if the input is animated, 0 if it is not animated.
Arguments
None
Syntax
<IntType> Animated()

CanBeAnimated
Explanation
Returns 1 if the input can be animated, 0 if the input cannot be animated.
Arguments
None
Syntax
<IntType> CanBeAnimated()

Disconnect
Explanation
Disconnects the node that is plugged into this input.
Arguments
None

Shader Node Input Methods

195 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> Disconnect()

InNode
Explanation
Returns the shader node that is plugged into this input. Returns none if no shader
node is plugged into this input.
Arguments
Caller can optionally pass a recurseToFirstNonCompound argument. If 1,
method recursively traverses any compound sub-tree to find the first node that is
not a compound type.
Syntax
<ShaderNodeType> InNode({<IntType>recurseToFirstNonCompound})

InOutput
Explanation
Returns the output of the shader node that is plugged in this input. Returns none if
no shader node is plugged in.
Arguments
None
Syntax
<ShaderNodeOutputType> InOutput()

InternalName
Explanation
Get the internal name of the shader node input.
Arguments
None
Syntax
<StringType> InternalName()

ItsNode
Explanation
Returns the shader node to which this input belongs.
Arguments
None
Syntax
<ShaderNodeType> ItsNode()

Name
Explanation
Get the (external) name of the shader node input.

Shader Node Input Methods

196 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<StringType> Name()

Parameters
Explanation
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.
Arguments
None
Syntax
(<ParmType> r, <ParmType> g, <ParmType> b) Parameters()

SetAnimated
Explanation
Set the animation status of this input. Set it to 1 for the input to be animated, 0 for
it not to be animated.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetAnimated(<IntType> animated)

SetColor
Explanation
Set the value of a color or vector input.
Arguments
Specify the RGB value of the desired color.
Syntax
<NoneType> SetColor(<FloatType> r, <FloatType> g, <FloatType> b)

SetFloat
Explanation
Set the value of a float, integer, Boolean or menu input.
Arguments
Enter the value you wish to set.
Syntax
<NoneType> SetFloat(<FloatType> value)

SetName
Explanation
Set the (external) name.

Shader Node Input Methods

197 Poser 11
PoserPython Methods Manual

Arguments
Enter the desired name.
Syntax
<NoneType> SetName(<StringType> Name)

SetString
Explanation
Set the string value. In this version of Poser, this is the path of a texture or movie
file.
Arguments
Enter the path name for the desired texture or movie file.
Syntax
<NoneType> SetString(<StringValue> file)

Texture
Explanation
Get the texture associated with this input
Arguments
None
Syntax
<TextureType> Texture()

Type
Explanation
Get the type of data accepted by the current input. The types are defined as
Poser member variables such as poser.kNodeInputCodeCOLOR.
Arguments
None
Syntax
<IntType> Type()

Value
Explanation
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.
Arguments
None
Syntax
<FloatType> Value()
(<FloatType>, <FloatType>, <FloatType>) Value()
<StringType> Value()

Shader Node Input Methods

198 Poser 11
PoserPython Methods Manual

FireFly Options Methods

This class of methods was introduced in Poser 6.0.0.

AutoValue
Explanation
Get the value of the automatic render settings slider.
Arguments
None
Syntax
<IntType> AutoValue()

BucketSize
Explanation
Get the bucket size.
Arguments
None
Syntax
<IntType> BucketSize()

DepthOfField
Explanation
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.
Arguments
None
Syntax
<IntType> DepthOfField()

Displacement
Explanation
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.
Arguments
None
Syntax
<IntType> Displacement()

DisplacementBounds
Explanation
Get the size of the displacement bounds.

FireFly Options Methods

199 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<FloatType> DisplacementBounds()

DrawToonOutline
Explanation
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.
Arguments
None
Syntax
<IntType> DrawToonOutline()

ExtraOutput
Explanation
Get whether auxiliary data should be rendered, and included as layer in the
rendered image.
Arguments
Specify the type of auxiliary render data.
Syntax
<IntType> ExtraOutput(<IntType> output)

FilterSize
Explanation
Get the post filter size.
Arguments
None
Syntax
<IntType> FilterSize()

FilterType
Explanation
Get the post filter type.
Arguments
None
Syntax
<IntType> FilterType()

GIIntensity
Explanation
Get the intensity of indirect light. A value of 0 indicates that global illumination is

FireFly Options Methods

200 Poser 11
PoserPython Methods Manual

turned off. Note: This method is not officially supported by Smith Micro Software,
and we make no guarantees as to its functionality or its future availability.
Arguments
None
Syntax
<FloatType> GIIntensity()

GIMaxError
Explanation
Get the Max Error of the irradiance cache. Valid values are in the range
between 0 and 1.
Arguments
None
Syntax
<FloatType> GIMaxError()

GINumBounces
Explanation
Get the number of bounces used for indirect light, Higher values result in better
quality and longer render times. Note: This method is not officially supported by
Smith Micro Software, and we make no guarantees as to its functionality or its
future availability.
Arguments
None
Syntax
<IntType> GINumBounces()

GINumSamples
Explanation
Get the number of rays used for global illumination, Higher values result in better
quality and longer render times. Note: This method is not officially supported by
Smith Micro Software, and we make no guarantees as to its functionality or its
future availability.
Arguments
None
Syntax
<IntType> GINumSamples()

GIOnlyRender
Explanation
Queries whether or not only indirect light is being rendered. A return value of 1
stands for indirect light only, 0 indicates a regular render.
Arguments
None

FireFly Options Methods

201 Poser 11
PoserPython Methods Manual

Syntax
<IntType> GIOnlyRender()

GIPassScale
Explanation
Get the scaling factor for the indirect light prepass.
Arguments
None
Syntax
<FloatType> GIPassScale()

Gamma
Explanation
Get the gamma value that is applied during gamma correction.
Arguments
None
Syntax
<FloatType> Gamma()

HDRIOutput
Explanation
Query if FireFly optimizes rendering for HDRI output.
Arguments
None
Syntax
<IntType> HDRIOutput()

Hider
Explanation
Get the current hider. Possible values are poser.kHiderREYES and poser.
kHiderRayTrace.
Arguments
None
Syntax
<StringType> Hider()

LoadPreset
Explanation
Load options from a render preset (.prp file).
Arguments
Specify the full path for the preset file.
Syntax
<NoneType> LoadPreset(<StringType> presetFilePath)

FireFly Options Methods

202 Poser 11
PoserPython Methods Manual

Manual
Explanation
Query whether manual render settings apply. A return value of 1 indicates that
manual settings apply; a return value of 0 indicates that automatic settings
apply.
Arguments
None
Syntax
<IntType> Manual()

MaxError
Explanation
Get the Maximum Error of the occlusion cache. Valid values are in the range
between 0 and 1.
Arguments
None
Syntax
<FloatType> MaxError()

MaxRayDepth
Explanation
Get the maximum number of raytrace bounces.
Arguments
None
Syntax
<IntType> MaxRayDepth()

MaxSampleSize
Explanation
Get the maximum distance between two irradiance samples. Note: This method
is not officially supported by Smith Micro Software, and we make no guarantees
as to its functionality or its future availability.
Arguments
None
Syntax
<FloatType> MaxSampleSize()

MaxTextureRes
Explanation
Get the max texture resolution.
Arguments
None
Syntax
<IntType> MaxTextureRes()

FireFly Options Methods

203 Poser 11
PoserPython Methods Manual

MinShadingRate
Explanation
Get the minimum shading rate.
Arguments
None
Syntax
<FloatType> MinShadingRate()

MotionBlur
Explanation
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.
Arguments
None
Syntax
<IntType> MotionBlur()

PixelSamples
Explanation
Get the number of samples per pixel.
Arguments
None
Syntax
<IntType> PixelSamples()

RayAccelerator
Explanation
Get the current ray accelerator. Return value is a constant such as
kRayAcceleratorCodeKDTREE (see FireFly Options Codes section for more
possible return values). Note: This method is not officially supported by Smith
Micro Software, and we make no guarantees as to its functionality or its future
availability.
Arguments
None
Syntax
<IntType> RayAccelerator()

RayTracing
Explanation
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.
Arguments
None

FireFly Options Methods

204 Poser 11
PoserPython Methods Manual

Syntax
<IntType> RayTracing()

RemoveBackfacing
Explanation
Query whether or not remove backfacing polygons is enabled. A return value
of 1 indicates that backfacing polygons will be removed; a return value of 0
indicates that they will not be removed.
Arguments
None
Syntax
<IntType> RemoveBackfacing()

SavePreset
Explanation
Save the current render options to a preset (.prp file).
Arguments
Specify the full path for the new .prp file.
Syntax
<NoneType> SavePreset(<StringType> presetFilePath)

SetAutoValue
Explanation
Set the value of the automatic render settings slider. Values from 0 to 8 (inclusive)
are valid.
Arguments
Specify the slider value as an integer between 0 and 8 (inclusive).
Syntax
<NoneType> SetAutoValue(<IntType> value)

SetBucketSize
Explanation
Set the bucket size.
Arguments
Enter the bucket size value.
Syntax
<NoneType> BucketSize(<IntType> size)

SetDepthOfField
Explanation
Set whether depth of field is enabled. A value of 1 enables depth of field, and 0
disables it.

FireFly Options Methods

205 Poser 11
PoserPython Methods Manual

Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetDepthOfField(<IntType> depthoffield)

SetDisplacement
Explanation
Set whether displacement is enabled. A value of 1 enables displacement, and 0
disables it.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetDisplacement(<IntType> displacement)

SetDisplacementBounds
Explanation
Set the size of the displacement bounds.
Arguments
Enter a floating-point value that represents the displacement bounds.
Syntax
<NoneType> SetDisplacmentBounds(<FloatType> bounds)

SetDrawToonOutline
Explanation
Set whether toon outlines are being drawn. A value of 1 enables toon outlines,
and 0 disables them.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetDrawToonOutline(<IntType> drawoutlines)

SetExtraOutput
Explanation
Set whether auxiliary data should be rendered and included as layer in the
rendered image.
Arguments
Enter the type of auxiliary render data. A value of 1 will enable that type, and a
value of 0 will disable.
Syntax
<NoneType> SetExtraOutput(<IntType> output, <IntType> enabled)

FireFly Options Methods

206 Poser 11
PoserPython Methods Manual

SetFilterSize
Explanation
Set the post filter size.
Arguments
Enter an integer value to represent the post filter size.
Syntax
<NoneType> SetFilterSize(<IntType> size)

SetFilterType
Explanation
Set the post filter type.
Arguments
Enter the constant defined for the desired post filter type.
Syntax
<NoneType> SetFilterType(<IntType> type)

SetGamma
Explanation
Set the Gamma correction of FireFly.
Arguments
none
Syntax
<NoneType> SetGamma(<FloatType> gamma)

SetGIIntensity
Explanation
Set the intensity of indirect light. A value of 0 turns off global illumination. Note:
This method is not officially supported by Smith Micro Software, and we make no
guarantees as to its functionality or its future availability.
Arguments
Specify the indirect light intensity as a floating-point number.
Syntax
<NoneType> SetGIIntensity(<FloatType> intensity)

SetGIMaxError
Explanation
Set the Max Error of the irradiance cache. Valid values are in the range between
0 and 1.
Arguments
Enter a valid value to represent the maximum acceptable error.
Syntax
<NoneType> SetGIMaxError(<FloatType> maxError)

FireFly Options Methods

207 Poser 11
PoserPython Methods Manual

SetGINumBounces
Explanation
Set the number of bounces for indirect light. Higher values result in better quality
and longer render times. Note: This method is not officially supported by Smith
Micro Software, and we make no guarantees as to its functionality or its future
availability.
Arguments
Enter an integer value to represent the number of bounces.
Syntax
<NoneType> SetGINumBounces(<IntType> bounces)

SetGINumSamples
Explanation
Set the number of rays used for global illumination. Higher values result in better
quality and longer render times. Note: This method is not officially supported by
Smith Micro Software, and we make no guarantees as to its functionality or its
future availability.
Arguments
Enter an integer value to represent the number of rays.
Syntax
<NoneType> SetGINumSamples(<IntType> samples)

SetGIOnlyRender
Explanation
Set if only indirect light are being rendered. A value of 0 enables regular renders,
1 enables indirect light only rendering.
Arguments
Enter either 0 for regular rendering, or 1 for indirect light only rendering.
Syntax
<NoneType> SetGIOnlyRender(<IntType> gionly)

SetGIPassScale
Explanation
Set the scaling factor for the indirect light prepass.
Example
SetGIPassScale(.5) will result in FireFly rendering the indirect light pre-pass at half
of the resolution of the final pass, e.g. at 960x540 instead of the full 1920x1080.
Arguments
Specify the scale factor as a floating-point number.
Syntax
<NoneType> SetGIPassScale(<FloatType> scale)

FireFly Options Methods

208 Poser 11
PoserPython Methods Manual

SetHDRIOutput
Explanation
Set if FireFly optimizes Rendering for HDRI output.
Arguments
Enter 0 to disable optimization for HDRI output, and 1 to enable.
Syntax
<NoneType> SetHDRIOutput(<IntType> hdri)

SetHider
Explanation
Set the current hider.
Arguments
Possible values are poser.kHiderREYES and poser.kHiderRayTrace.
Syntax
<NoneType> SetHider(<IntType> hiderType)

SetManual
Explanation
Set whether manual render settings should apply. Enter a value of 1 for manual
settings, or 0 for automatic settings.
Arguments
Enter either 0 or 1 to specify automatic or manual settings.
Syntax
<NoneType> SetManual(<IntType> manual)

SetMaxError
Explanation
Set the Maximum Error of the occlusion cache. Valid values are in the range
between 0 and 1.
Arguments
Specify the Maximum Error as a floating-point number between 0 and 1.
Syntax
<NoneType> SetMaxError(<FloatType> maxError)

SetMaxRayDepth
Explanation
Set the maximum number of raytrace bounces.
Arguments
Enter the desired maximum number.
Syntax
<NoneType> SetMaxRayDepth(<IntType> depth)

FireFly Options Methods

209 Poser 11
PoserPython Methods Manual

SetMaxSampleSize
Explanation
Set the maximum distance between two irradiance samples. Note: This
method is not officially supported by Smith Micro Software, and we make
no guarantees as to its functionality or its future availabiArguments
Specify the maximum distance as a floating-point number.
Syntax
<NoneType> SetMaxSampleSize(<FloatType> maxSize)

SetMaxTextureRes
Explanation
Set the maximum texture resolution.
Arguments
Specify the maximum x and y resolution at which Poser will load figures. Both x
and y share a single value.
Syntax
<NoneType> SetMaxTextureRes(<IntType> resolution)

SetMinShadingRate
Explanation
Set the minimum shading rate.
Arguments
Specify the desired minimum shading rate.
Syntax
<NoneType> SetMinShadingRate(<FloatType> shadingrate)

SetMotionBlur
Explanation
Set whether motion blur is enabled. A value of 1 enables motion blur, and 0
disables it.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetMotionBlur(<IntType> enabled)

SetPixelSamples
Explanation
Set the number of samples per pixel.
Arguments
Enter the desired sample value.
Syntax
<NoneType> SetPixelSamples(<IntType> numsamples)

FireFly Options Methods

210 Poser 11
PoserPython Methods Manual

SetRayAccelerator
Explanation
Set the ray accelerator. The value should be a constant such as
kRayAcceleratorCodeKDTREE (see FireFly Options Codes for more possible ray
accelerator constants). Note: This method is not officially supported by Smith
Micro Software, and we make no guarantees as to its functionality or its future
availability. Use at your own risk.
Arguments
Specify the ray accelerator constant.
Syntax
<NoneType> SetRayAccelerator(<IntType> acceleratorType)

SetRayTracing
Explanation
Set whether raytracing is enabled. A value of 1 enables raytracing, and 0
disables it.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetRayTracing(<IntType> raytracing)

SetRemoveBackfacing
Explanation
Set whether remove backfacing polygons is enabled. A value of 1 specifies that
backfacing polygons will be removed; a value of 0 specifies that they will not be
removed.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetRemoveBackfacing(<IntType> enabled)

SetShadowOnlyRender
Explanation
Set whether only shadows are being rendered. A value of 1 enables regular
renders, and 0 enables shadow only renders.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetShadowsOnlyRender(<IntType> shadowsonly)

SetShadows
Explanation
Set whether shadows are being rendered. A value of 1 enables shadow
rendering, and 0 disables it.

FireFly Options Methods

211 Poser 11
PoserPython Methods Manual

Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetShadows(<IntType> doshadows)

SetSmoothPolys
Explanation
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.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetSmoothPolys(<IntType> dosmoothing)

SetTextureCacheCompression
Explanation
Set the compression scheme FireFly uses for disk-based textures. The return value
is a constant such as kTextureCompressorCodeZIP (see FireFly Options Codes for
more possible compression codes). Note: This method is not officially supported
by Smith Micro Software, and we make no guarantees as to its functionality or its
future availability.
Arguments
Specify the constant for the desired compression scheme.
Syntax
<NoneType> SetTextureCacheCompression(<IntType> compression)

SetTextureCacheSize
Explanation
Set the texture cache size (in KB). This setting determines how much RAM FireFly
will reserve to cache disk-based textures. Note: This method is not officially
supported by Smith Micro Software, and we make no guarantees as to its
functionality or its future availability. Use at your own risk.
Arguments
Enter an integer to represent the cache size in KB.
Syntax
<NoneType> SetTextureCacheSize(<IntType> cacheSize)

SetTextureFiltering
Explanation
Set whether texture filtering is enabled. A value of 1 enables texture filtering, and
0 disables it.
Arguments
Enter a value of either 1 or 0.

FireFly Options Methods

212 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SetTextureFiltering(<IntType> filtering)

SetToneExposure
Explanation
Set the tone mapping exposure.
Arguments
Enter exposure as floating point value.
Syntax
<NoneType> SetToneExposure(<FloatType> exposure)

SetToneGain
Explanation
Set the tone mapping gain.
Arguments
Enter gain as floating point value.
Syntax
<NoneType> SetToneGain(<FloatType> gain)

SetToneMapper
Explanation
Set the tone mapping operator. Poser supports 0 = no tone mapping and 1 =
exponential tone mapping.
Arguments
Enter 0 to disable tone mapping, and 1 to enable exponential tone mapping.
Syntax
<IntType> ToneMapper()

SetToonOutlineStyle
Explanation
Set the toon outline style.
Arguments
Enter a constant representing the desired toon outline style.
Syntax
<NoneType> SetToonOutlineStyle(<IntType> outlinestyle)

SetUseGI
Explanation
Enables or disables indirect light.
Arguments
Enter a value of 0 to disable indirect light, or a value of 1 to enable it.
Syntax
<NoneType> SetUseGI(<IntType> usegi)

FireFly Options Methods

213 Poser 11
PoserPython Methods Manual

SetUseGamma
Explanation
Set if FireFly applies Gamma correction.
Arguments
Enter 0 to disable gamma correction, and 1 to enable.
Syntax
<NoneType> SetUseGamma(<IntType> usegamma)

SetUseIrradianceCache
Explanation
Set if irradiance caching is enabled. A value of 0 stands for disabled, 1 stands for
enabled.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetUseIrradianceCache(<IntType> useirradiancecache

SetUseOcclusionCulling
Explanation
Set whether FireFly performs occlusion culling to improve performance. A value
of 1 enables occlusion culling; a value of 0 disables it. Note: This method is not
officially supported by Smith Micro Software, and we make no guarantees as to
its functionality or its future availability.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetUseOcclusionCulling(<IntType> useOcclusionCulling)

SetUseSSS
Explanation
Enables or disables subsurface scattering.
Arguments
Enter a value of 0 to disable SSS, or a value of 1 to enable it.
Syntax
<NoneType> SetUseSSS(<IntType> usesss)

SetUseTextureCache
Explanation
Set whether FireFly uses cached disk-based textures instead of loading the entire
texture into RAM. A value of 1 enables texture caching; a value of 0 disables
it. Note: This method is not officially supported by Smith Micro Software, and we
make no guarantees as to its functionality or its future availability.
Arguments
Enter a value of either 1 or 0.

FireFly Options Methods

214 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> SetUseTextureCache(<IntType> useCache)

ShadowOnlyRender
Explanation
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.
Arguments
None
Syntax
<IntType> ShadowOnlyRender()

Shadows
Explanation
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.
Arguments
None
Syntax
<IntType> Shadows()

SmoothPolys
Explanation
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.
Arguments
None
Syntax
<IntType> SmoothPolys()

TextureCacheCompression
Explanation
Get the compression scheme FireFly uses for disk-based textures. The return
value will be a constant such as kTextureCompressorCodeZIP (see FireFly Options
Codes for more possible compression schemes). Note: This method is not
officially supported by Smith Micro Software, and we make no guarantees as to
its functionality or its future availability.
Arguments
None
Syntax
<IntType> TextureCacheCompression()

FireFly Options Methods

215 Poser 11
PoserPython Methods Manual

TextureCacheSize
Explanation
Get the texture cache size (in KB). This value determines how much RAM FireFly
will reserve to cache disk-based textures. Note: This method is not officially
supported by Smith Micro Software, and we make no guarantees as to its
functionality or its future availability.
Arguments
None
Syntax
<IntType> TextureCacheSize()

TextureFiltering
Explanation
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.
Arguments
None
Syntax
<IntType> TextureFiltering()

ToneExposure
Explanation
Get the tone mapping exposure.
Arguments
None
Syntax
<FloatType> ToneExposure()

ToneGain
Explanation
Get the tone mapping gain.
Arguments
None
Syntax
<FloatType> ToneGain()

ToneMapper
Explanation
Get the tone mapping operator. Supports 0 = no tone mapping and 1 =
exponential tone mapping.
Arguments
None

FireFly Options Methods

216 Poser 11
PoserPython Methods Manual

Syntax
<IntType> ToneMapper()

ToonOutlineStyle
Explanation
Queries for toon outline style.
Arguments
None
Syntax
<IntType> ToonOutlineStyle()

UseGI
Explanation
Queries whether or not indirect light is enabled. A return value of 1 indicates
indirect light is enabled, 0 indicates indirect light is disabled.
Arguments
None
Syntax
<IntType> UseGI()

UseGamma
Explanation
Query if FireFly applies Gamma correction.
Arguments
None
Syntax
<IntType> UseGamma()

UseIrradianceCache
Explanation
Queries whether or not irradiance caching is enabled. A return value of 1 stands
for irradiance caching enabled, 0 indicates irradiance caching disabled.
Arguments
None
Syntax
<IntType> UseIrradianceCache()

UseOcclusionCulling
Explanation
Query whether FireFly performs occlusion culling to improve performance. A
return value of 1 indicates that occlusion culling is enabled; a return value of 0
indicates that it is disabled. Note: This method is not officially supported by Smith
Micro Software, and we make no guarantees as to its functionality or its future
availability.

FireFly Options Methods

217 Poser 11
PoserPython Methods Manual

Arguments
None
Syntax
<IntType> UseOcclusionCulling()

UseSSS
Explanation
Queries whether or not subsurface scattering is enabled. A return value of 1
stands for enabled, 0 indicates disabled.
Arguments
None
Syntax
<IntType> UseSSS()

UseTextureCache
Explanation
Query whether FireFly uses cached disk-based textures instead of loading the
entire texture into RAM. A return value of 1 indicates that texture caching is
enabled; a return value of 0 indicates that it is disabled. Note: This method is not
officially supported by Smith Micro Software, and we make no guarantees as to
its functionality or its future availability.
Arguments
None
Syntax
<IntType> UseTextureCache()

SuperFly Options Methods

AOSamples
Explanation
Get number of AO samples.
Arguments
none
Syntax
<IntType> AOSamples()

BranchedPathTracing
Explanation
Get BranchedPathTracing.
Arguments
none
Syntax
<BoolType> BranchedPathTracing()

SuperFly Options Methods

218 Poser 11
PoserPython Methods Manual

BucketSize
Explanation
Get tile size.
Arguments
none
Syntax
<IntType> BucketSize()

ClampDirectSamples
Explanation
Get ClampDirectSamples.
Arguments
none
Syntax
<FloatType> ClampDirectSamples()

ClampIndirectSamples
Explanation
Get ClampIndirectSamples.
Arguments
none
Syntax
<FloatType> ClampIndirectSamples()

DepthOfField
Explanation
Get DepthOfField.
Arguments
none
Syntax
<BoolType> DepthOfField()

Device
Explanation
Gets Device for rendering (CPU, CUDA).
Arguments
none
Syntax
Device()

SuperFly Options Methods

219 Poser 11
PoserPython Methods Manual

Devices
Explanation
Gets All Devices for rendering (CPU, CUDA).
Arguments
none
Syntax
<ListType> Devices()

DiffuseBounces
Explanation
Get number of Diffuse bounces.
Arguments
none
Syntax
<IntType> DiffuseBounces()

DiffuseSamples
Explanation
Get number of Diffuse samples.
Arguments
none
Syntax
<IntType> DiffuseSamples()

FilterGlossy
Explanation
Get FilterGlossy.
Arguments
none
Syntax
<FloatType> FilterGlossy()

GlossyBounces
Explanation
Get number of Glossy bounces.
Arguments
none
Syntax
<IntType> GlossyBounces()

SuperFly Options Methods

220 Poser 11
PoserPython Methods Manual

GlossySamples
Explanation
Get number of Glossy samples.
Arguments
none
Syntax
<IntType> GlossySamples()

MaxBounces
Explanation
Get Max number of bounces.
Arguments
none
Syntax
<IntType> MaxBounces()

MaxTransparentBounces
Explanation
Get Max number of Transparent bounces.
Arguments
none
Syntax
<IntType> MaxTransparentBounces()

MeshLightSamples
Explanation
Get number of Mesh Light samples.
Arguments
none
Syntax
<IntType> MeshLightSamples()

MinBounces
Explanation
Get Min number of bounces.
Arguments
none
Syntax
<IntType> Bounces()

SuperFly Options Methods

221 Poser 11
PoserPython Methods Manual

MinTransparentBounces
Explanation
Get Min number of Transparent bounces.
Arguments
none
Syntax
<IntType> MinTransparentBounces()

MotionBlur
Explanation
Get MotionBlur.
Arguments
none
Syntax
<BoolType> MotionBlur()

PixelSamples
Explanation
Get number of AA samples.
Arguments
none
Syntax
<IntType> PixelSamples()

ProgressiveRefinement
Explanation
Get ProgressiveRefinement.
Arguments
none
Syntax
<BoolType> ProgressiveRefinement()

ReflectiveCaustics
Explanation
Get ReflectiveCaustics.
Arguments
none
Syntax
<BoolType> ReflectiveCaustics()

SuperFly Options Methods

222 Poser 11
PoserPython Methods Manual

RefractiveCaustics
Explanation
Get RefractiveCaustics.
Arguments
none
Syntax
<BoolType> RefractiveCaustics()

SampleAllLightsDirect
Explanation
Get SampleAllLightsDirect.
Arguments
none
Syntax
<BoolType> SampleAllLightsDirect()

SampleAllLightsIndirect
Explanation
Get SampleAllLightsIndirect.
Arguments
none
Syntax
<BoolType> SampleAllLightsIndirect()

SetAOSamples
Explanation
Set number of AO samples.
Arguments
none
Syntax
<NoneType> SetAOSamples(<IntType> samples)

SetBranchedPathTracing
Explanation
Set BranchedPathTracing.
Arguments
none
Syntax
<NoneType> SetBranchedPathTracing(<BoolType> value)

SuperFly Options Methods

223 Poser 11
PoserPython Methods Manual

SetBucketSize
Explanation
Set tile size.
Arguments
none
Syntax
<NoneType> SetBucketSize(<IntType> value)

SetClampDirectSamples
Explanation
Set ClampDirectSamples.
Arguments
none
Syntax
<NoneType> SetClampDirectSamples(<FloatType> value)

SetClampIndirectSamples
Explanation
Set ClampIndirectSamples.
Arguments
none
Syntax
<NoneType> SetClampIndirectSamples(<FloatType> value)

SetDepthOfField
Explanation
Set DepthOfField.
Arguments
none
Syntax
<NoneType> SetDepthOfField(<BoolType> value)

SetDevice
Explanation
Sets Device for rendering (CPU, CUDA).
Arguments
none
Syntax
<NoneType> SetDevice(<StringType> device)

SuperFly Options Methods

224 Poser 11
PoserPython Methods Manual

SetDiffuseBounces
Explanation
Set number of Diffuse bounces.
Arguments
none
Syntax
<NoneType> SetDiffuseBounces(<IntType> bounces)

SetDiffuseSamples
Explanation
Set number of Diffuse samples.
Arguments
none
Syntax
<NoneType> SetDiffuseSamples(<IntType> samples)

SetFilterGlossy
Explanation
Set FilterGlossy.
Arguments
none
Syntax
<NoneType> SetFilterGlossy(<FloatType> value)

SetGlossyBounces
Explanation
Set number of Glossy bounces.
Arguments
none
Syntax
<NoneType> SetGlossyBounces(<IntType> bounces)

SetGlossySamples
Explanation
Set number of Glossy samples.
Arguments
none
Syntax
<NoneType> SetGlossySamples(<IntType> samples)

SuperFly Options Methods

225 Poser 11
PoserPython Methods Manual

SetMaxBounces
Explanation
Set Max number of bounces.
Arguments
none
Syntax
<NoneType> SetMaxBounces(<IntType> bounces)

SetMaxTransparentBounces
Explanation
Set Max number of Transparent bounces.
Arguments
none
Syntax
<NoneType> SetMaxTransparentBounces(<IntType> bounces)

SetMeshLightSamples
Explanation
Set number of Mesh Light samples.
Arguments
none
Syntax
<NoneType> SetMeshLightSamples(<IntType> samples)

SetMinBounces
Explanation
Set Min number of bounces.
Arguments
none
Syntax
<NoneType> SetMinBounces(<IntType> bounces)

SetMinTransparentBounces
Explanation
Set Min number of Transparent bounces.
Arguments
none
Syntax
<NoneType> SetMinTransparentBounces(<IntType> bounces)

SuperFly Options Methods

226 Poser 11
PoserPython Methods Manual

SetMotionBlur
Explanation
Set MotionBlur.
Arguments
none
Syntax
<NoneType> SetMotionBlur(<BoolType> value)

SetPixelSamples
Explanation
Set number of AA samples.
Arguments
none
Syntax
<NoneType> SetPixelSamples(<IntType> samples)

SetProgressiveRefinement
Explanation
Set ProgressiveRefinement.
Arguments
none
Syntax
<NoneType> SetProgressiveRefinement(<BoolType> value)

SetReflectiveCaustics
Explanation
Set ReflectiveCaustics.
Arguments
none
Syntax
<NoneType> SetReflectiveCaustics(<BoolType> value)

SetRefractiveCaustics
Explanation
Set RefractiveCaustics.
Arguments
none
Syntax
<NoneType> SetRefractiveCaustics(<BoolType> value)

SuperFly Options Methods

227 Poser 11
PoserPython Methods Manual

SetSampleAllLightsDirect
Explanation
Set SampleAllLightsDirect.
Arguments
none
Syntax
<NoneType> SetSampleAllLightsDirect(<BoolType> value)

SetSampleAllLightsIndirect
Explanation
Set SampleAllLightsIndirect.
Arguments
none
Syntax
<NoneType> SetSampleAllLightsIndirect(<BoolType> value)

SetSubsurfaceSamples
Explanation
Set number of Subsurface samples.
Arguments
none
Syntax
<NoneType> SetSubsurfaceSamples(<IntType> samples)

SetTransmissionBounces
Explanation
Set number of Transmission bounces.
Arguments
none
Syntax
<NoneType> SetTransmissionBounces(<IntType> bounces)

SetTransmissionSamples
Explanation
Set number of Transmission samples.
Arguments
none
Syntax
<NoneType> SetTransmissionSamples(<IntType> samples)

SuperFly Options Methods

228 Poser 11
PoserPython Methods Manual

SetVolumeBounces
Explanation
Set number of Volume bounces.
Arguments
none
Syntax
<NoneType> SetVolumeBounces(<IntType> bounces)

SetVolumeSamples
Explanation
Set number of Volume samples.
Arguments
none
Syntax
<NoneType> SetVolumeSamples(<IntType> samples)

SubsurfaceSamples
Explanation
Get number of Subsurface samples.
Arguments
none
Syntax
<IntType> SubsurfaceSamples()

TransmissionBounces
Explanation
Get number of Transmission bounces.
Arguments
none
Syntax
<IntType> TransmissionBounces()

TransmissionSamples
Explanation
Get number of Transmission samples.
Arguments
none
Syntax
<IntType> TransmissionSamples()

SuperFly Options Methods

229 Poser 11
PoserPython Methods Manual

VolumeBounces
Explanation
Get number of Volume bounces.
Arguments
none
Syntax
<IntType> VolumeBounces()

VolumeSamples
Explanation
Get number of Volume samples.
Arguments
none
Syntax
<IntType> VolumeSamples()

Hair Methods
This class of methods was introduced in Poser 6.0.0.

AirDamping
Explanation
Get the air damping value.
Arguments
None
Syntax
<FloatType> AirDamping()

BendResistance
Explanation
Get the bend resistance.
Arguments
None
Syntax
<FloatType> BendResistance()

CalculateDynamics
Explanation
Calculate this group’s 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.
Arguments
None

Hair Methods
230 Poser 11
PoserPython Methods Manual

Syntax
<ActorType> CalculateDynamics()

Clumpiness
Explanation
Get the clumpiness value.
Arguments
None
Syntax
<FloatType> Clumpiness()

CollisionsOn
Explanation
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.
Arguments
None
Syntax
<IntType> CollisionsOn()

Delete
Explanation
Delete the hair group and its associated hair prop.
Arguments
None
Syntax
<ActorType> Delete()

Density
Explanation
Get the density of populated hairs.
Arguments
None
Syntax
<FloatType> Density()

Gravity
Explanation
Get the gravity value.
Arguments
None

Hair Methods
231 Poser 11
PoserPython Methods Manual

Syntax
<FloatType> Gravity()

GrowHair
Explanation
Grow guide hairs.
Arguments
None
Syntax
<NoneType> GrowHair()

HairProp
Explanation
Get the prop that represents this hair group.
Arguments
None
Syntax
<ActorType> HairProp()

KinkDelay
Explanation
Get the kink delay value.
Arguments
None
Syntax
<FloatType> KinkDelay()

KinkScale
Explanation
Get the kink scale value.
Arguments
None
Syntax
<FloatType> KinkScale()

KinkStrength
Explanation
Get the kink strength value.
Arguments
None
Syntax
<FloatType> KinkStrength()

Hair Methods
232 Poser 11
PoserPython Methods Manual

LengthMax
Explanation
Get the maximum hair length.
Arguments
None
Syntax
<FloatType> LengthMax()

LengthMin
Explanation
Get the minimum hair length.
Arguments
none
Syntax
<FloatType> LengthMin()

Name
Explanation
Get the name of this Hair.
Arguments
None
Syntax
<StringType> Name()

NumbPopHairs
Explanation
Get the total number of Hairs.
Arguments
None
Syntax
<IntType> NumbPopHairs()

NumbVertsPerHair
Explanation
Get the number of vertices per hair.
Arguments
None
Syntax
<IntType> NumbVertsPerHair()

Hair Methods
233 Poser 11
PoserPython Methods Manual

PositionForce
Explanation
Get the internal PositionForce simulation parameter.
Arguments
None
Syntax
<FloatType> PositionForce()

PullBack
Explanation
Get the pull back parameter value.
Arguments
None
Syntax
<FloatType> PullBack()

PullDown
Explanation
Get the pull down parameter value.
Arguments
None
Syntax
<FloatType> PullDown()

PullLeft
Explanation
Get the pull left parameter value.
Arguments
None
Syntax
<FloatType> PullLeft()

RootStiffness
Explanation
Get the root stiffness.
Arguments
None
Syntax
<FloatType> RootStiffness()

Hair Methods
234 Poser 11
PoserPython Methods Manual

RootStiffnessFalloff
Explanation
Get the root stiffness falloff.
Arguments
None
Syntax
<FloatType> RootStiffnessFalloff()

RootWidth
Explanation
Get the hair root width.
Arguments
None
Syntax
<FloatType> RootWidth()

SetAirDamping
Explanation
Set the air damping.
Arguments
Specify the air damping as a floating-point number.
Syntax
<NoneType> SetAirDamping(<FloatType> value)

SetBendResistance
Explanation
Set the bend resistance.
Arguments
Specify the bend resistance as a floating-point number.
Syntax
<NoneType> SetBendResistance(<FloatType> value)

SetClumpiness
Explanation
Set the hair clumpiness.
Arguments
Specify the clumpiness as a floating-point number.
Syntax
<NoneType> SetClumpiness(<FloatType> value)

Hair Methods
235 Poser 11
PoserPython Methods Manual

SetCollisionsOn
Explanation
Set whether or not this hair group reacts to collisions.
Arguments
Enter 1 to enable collision detection, and 0 to disable it.
Syntax
<NoneType> SetCollisionsOn(<IntType> value)

SetDensity
Explanation
Set the density of populated hairs.
Arguments
Specify the hair density as a floating-point number.
Syntax
<NoneType> SetDensity(<FloatType> value)

SetGravity
Explanation
Set the gravity.
Arguments
Specify gravity in g as a floating point number.
Syntax
<NoneType> SetGravity(<FloatType> value)

SetKinkDelay
Explanation
Set the kink delay.
Arguments
Specify the kink delay as a floating-point number.
Syntax
<NoneType> SetKinkDelay(<FloatType> value)

SetKinkScale
Explanation
Set the kink scale.
Arguments
Specify the kink scale as a floating-point number.
Syntax
<NoneType> SetKinkScale(<FloatType> value)

Hair Methods
236 Poser 11
PoserPython Methods Manual

SetKinkStrength
Explanation
Set the kink strength.
Arguments
Specify the kink strength as a floating-point number.
Syntax
<NoneType> SetKinkStrength(<FloatType> value)

SetLengthMax
Explanation
Set the maximum length.
Arguments
Enter the desired maximum length as a floating-point number.
Syntax
<NoneType> SetLengthMax(<FloatType> value)

SetLengthMin
Explanation
Set the minimum length.
Arguments
Enter the desired minimum length as a floating-point number.
Syntax
<NoneType> SetLengthMin(<FloatType> value)

SetName
Explanation
Set the name of this Hair.
Arguments
Specify the desired name.
Syntax
<StringType> SetName(<StringType> name)

SetNumbPopHairs
Explanation
Set the total number of hairs.
Arguments
Enter the total hair number value.
Syntax
<NoneType> SetNumbPopHairs(<IntType> value)

Hair Methods
237 Poser 11
PoserPython Methods Manual

SetNumbVertsPerHair
Explanation
Set the number of vertices per hair.
Arguments
Enter the value for the number of vertices.
Syntax
<NoneType> SetNumbVertsPerHair(<IntType> value)

SetPositionForce
Explanation
Set the internal PositionForce simulation parameter.
Arguments
Specify the PositionForce value as a floating-point number.
Syntax
<NoneType> SetPositionForce(<FloatType> value)

SetPullBack
Explanation
Set the pull back parameter.
Arguments
Specify the pull back value as a floating-point number.
Syntax
<NoneType> SetPullBack(<FloatType> value)

SetPullDown
Explanation
Set the pull down parameter.
Arguments
Specify the pull down value as a floating-point number.
Syntax
<NoneType> SetPullDown(<FloatType> value)

SetPullLeft
Explanation
Set the pull left parameter.
Arguments
Specify the pull left value as a floating-point number.
Syntax
<NoneType> SetPullLeft(<FloatType> value)

Hair Methods
238 Poser 11
PoserPython Methods Manual

SetRootStiffness
Explanation
Set the root stiffness.
Arguments
Specify the root stiffness as a floating-point number.
Syntax
<NoneType> SetRootStiffness(<FloatType> value)

SetRootStiffnessFalloff
Explanation
Set the root stiffness falloff.
Arguments
Specify the root stiffness falloff as a floating-point number.
Syntax
<NoneType> SetRootStiffnessFalloff(<FloatType> value)

SetRootWidth
Explanation
Set the hair root width.
Arguments
Specify the root width as a floating-point number.
Syntax
<NoneType> SetRootWidth(<FloatType> value)

SetShowPopulated
Explanation
Set whether populated hair is shown. A value of 1 indicates that it is shown, and
0 indicates that it is not shown.
Arguments
Enter a value of either 1 or 0.
Syntax
<NoneType> SetShowPopulated(<IntType> value)

SetSpringDamping
Explanation
Set the spring damping value.
Arguments
Specify the spring damping value as a floating-point number.
Syntax
<NoneType> SetSpringDamping(<FloatType> value)

Hair Methods
239 Poser 11
PoserPython Methods Manual

SetSpringStrength
Explanation
Set the spring strength value.
Arguments
Specify the spring strength value as a floating-point number.
Syntax
<NoneType> SetSpringStrength(<FloatType> value)

SetTipWidth
Explanation
Set the hair tip width.
Arguments
Specify the hair tip width as a floating-point number.
Syntax
<NoneType> SetTipWidth(<FloatType> value)

ShowPopulated
Explanation
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.
Arguments
None
Syntax
<IntType> ShowPopulated()

SpringDamping
Explanation
Get the spring damping value.
Arguments
None
Syntax
<FloatType> SpringDamping()

SpringStrength
Explanation
Get the spring strength value.
Arguments
None
Syntax
<FloatType> SpringStrength()

Hair Methods
240 Poser 11
PoserPython Methods Manual

TipWidth
Explanation
Get the hair tip width.
Arguments
None
Syntax
<FloatType> TipWidth()

Cloth Simulator Methods

This class of methods was introduced in Poser 6.0.0.

AddClothActor
Explanation
Add a clothified actor to this simulation.
Arguments
Specify the name of the actor you wish to add
Syntax
<NoneType> AddClothActor(<ActorType> actor)

AddCollisionActor
Explanation
Add an actor as a collision object to this simulation.
Arguments
Specify the name of the actor you wish to add
Syntax
<NoneType> AddCollisionActor(<ActorType> actor)

AddCollisionFigure
Explanation
Add a figure as a collision object to this simulation, excluding the group names in
the list.
Arguments
Specify the name of the actor you wish to add, plus the list of group names you
wish to exclude.
Syntax
<NoneType> AddCollisionFigure(<FigureType> figure, <StringType list>
excludeList)

CalculateDynamics
Explanation
Start the simulation calculation.
Arguments
None

Cloth Simulator Methods

241 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> CalculateDynamics()

ClearDynamics
Explanation
Clear the simulation dynamics cache.
Arguments
None
Syntax
<NoneType> ClearDynamics()

CurrentClothActor
Explanation
Get the current cloth actor.
Arguments
None
Syntax
<ActorType> CurrentClothActor()

Delete
Explanation
Removes this simulation from the scene.
Arguments
None
Syntax
<NoneType> Delete()

DrapingFrames
Explanation
Get the number of draping frames in this simulation.
Arguments
None
Syntax
<IntType> DrapingFrames()

DynamicsProperty
Explanation
Get the value of a named property. Property names are defined as Poser
member variables such as poser.kClothParmDENSITY.
Arguments
Specify the property for which you want the value.
Syntax
<FloatType> DynamicsProperty(<StringType> Name

Cloth Simulator Methods

242 Poser 11
PoserPython Methods Manual

EndFrame
Explanation
Get the end frame of this simulation.
Arguments
None
Syntax
<IntType> EndFrame()

IsClothActor
Explanation
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.
Arguments
Specify the name of the actor.
Syntax
<IntType> IsClothActor(<ActorType> actor)

IsCollisionActor
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.
Arguments
Specify the name of the actor.
Syntax
<IntType> IsCollisionActor(<ActorType> actor)

IsCollisionFigure
Explanation
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.
Arguments
Specify the name of the actor.
Syntax
<IntType> IsCollisionFigure(<FigureType> figure)

Name
Explanation
Get the name of the simulation.
Arguments
None
Syntax
<StringType> Name()

Cloth Simulator Methods

243 Poser 11
PoserPython Methods Manual

RemoveClothActor
Explanation
Remove a clothified actor from this simulation.
Arguments
Specify the name of the actor to remove.
Syntax
<NoneType> RemoveClothActor(<ActorType> actor)

RemoveCollisionActor
Explanation
Remove this actor as a collision object from this simulation.
Arguments
Specify the name of the actor to remove.
Syntax
<NoneType> RemoveCollisionActor(<ActorType> actor)

RemoveCollisionFigure
Explanation
Remove this figure as a collision object from this simulation.
Arguments
Specify the name of the figure to remove.
Syntax
<NoneType> RemoveCollisionFigure(<FigureType> figure)

SetCurrentClothActor
Explanation
Set the current cloth actor.
Arguments
Specify the actor.
Syntax
<NoneType> SetCurrentClothActor(<ActorType> Actor)

SetDrapingFrames
Explanation
Set the number of draping frames in this simulation.
Arguments
Specify the number of frames.
Syntax
<NoneType> SetDrapingFrames(<IntType> frames)

Cloth Simulator Methods

244 Poser 11
PoserPython Methods Manual

SetDynamicsProperty
Explanation
Set the value of a named property.
Arguments
Specify the property name and value.
Syntax
<NoneType> SetDynamicsProperty(<StringType> Name, <FloatType> Value)

SetEndFrame
Explanation
Set the end frame of this simulation.
Arguments
Enter the frame number.
Syntax
<NoneType> SetEndFrame(<IntType> frame)

SetName
Explanation
Set the name of the simulation.
Arguments
Enter the desired name.
Syntax
<StringType> Name(<StringType> name)

SetStartFrame
Explanation
Set the starting frame of this simulation.
Arguments
Enter the frame number.
Syntax
<NoneType> SetStartFrame(<IntType> frame)

StartFrame
Explanation
Get the starting frame of this simulation.
Arguments
None
Syntax
<IntType> StartFrame()

Cloth Simulator Methods

245 Poser 11
PoserPython Methods Manual

Shader Node Output Methods

ConnectToInput
Explanation
Connect the output to the given input.
Arguments
None
Syntax
<NoneType> ConnectToInput(<ShaderNodeInputType> Input)

InternalName
Explanation
Get the internal name.
Arguments
None
Syntax
<StringType> InternalName()

ItsNode
Explanation
Returns the shader node to which this output belongs.
Arguments
None
Syntax
<ShaderNodeType> ItsNode()

Name
Explanation
Get the (external) name.
Arguments
None
Syntax
<StringType> Name()

SetName
Explanation
Set the (external) name.
Arguments
None
Syntax
<NoneType> SetName(<StringType> Name)

Shader Node Output Methods

246 Poser 11
PoserPython Methods Manual

DialogSimple Methods
This class of methods was introduced in Poser 6.0.0.

AskActor
Explanation
Ask the user to select an actor.
Arguments
Enter the request message.
Syntax
<NoneType> AskActor(<StringType> message)

AskFloat
Explanation
Ask the user for a floating-point number.
Arguments
Enter the request message.
Syntax
<FloatType> AskFloat(<StringType> message)

AskInt
Explanation
Ask the user for an integer value.
Arguments
Enter the request message.
Syntax
<FloatType> AskInt(<StringType> message)

AskMenu
Explanation
Ask the user to select an item in a menu.
Arguments
Enter the menu title, the request message, and each of the subsequent items in
the menu.
Syntax
<StringType> AskMenu(<StringType> title, <StringType> message,
<StringType> item1, <StringType> item2, ...)

DialogSimple
Explanation
Creates an object of the DialogSimple class type – in other words, a simple
dialog.

DialogSimple Methods
247 Poser 11
PoserPython Methods Manual

Arguments
none
Syntax
<NoneType> DialogSimple()

MessageBox
Explanation
Show a message box with the message and an OK button.
Arguments
Enter the message.
Syntax
<NoneType> MessageBox(<StringType> message)

PickImage
Explanation
Bring up the Texture Manager and let the user pick an image for this input.
Arguments
Specify the input to which the new image node will be attached.
Syntax
<NoneType> PickImage(<ShaderNodeInputType> inputInput)

YesNo
Explanation
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.
Arguments
Enter the message.
Syntax
<IntType> YesNo(<StringType> message)

Dialog Methods
This class of methods was introduced in Poser 7.0.0.

AddButtonCallback
Explanation
Assigns a method callback function to a button click.
Arguments
Enter the button to which you wish to assign a callback, and the function you
wish to call when the button is clicked.
Syntax
<NoneType> AddButtonCallback(<StringType> buttonName, <FunctionType>
function)

Dialog Methods
248 Poser 11
PoserPython Methods Manual

Dialog
Explanation
Implements a message dialog callable from Poser’s Python interface.
Arguments
Enter the path for the of the XML file that defines the dialog layout, the title of the
dialog, the message the dialog should contain, and the height and width of the
dialog.
Syntax
<DialogType> Dialog(<StringType> layoutXMLPath, <StringType> title,
<StringType> message, <IntType> width, <IntType> height)

SetButtonValue
Explanation
Specify a numerical value for a button’s label.
Arguments
Specify the name of the buttona nd the value with which you wish to label it.
Syntax
<NoneType> SetButtonValue(<StringType> buttonName, <IntType> value)

SetText
Explanation
Specify the text for a dialog widget.
Arguments
Specify the widget name and the text you wish to accompany the widget.
Syntax
<NoneType> SetText(<StringType> widgetName, <StringType> text)

DialogFileChooser Methods
This class of methods was introduced in Poser 7.0.0.

DialogFileChooser
Explanation
Implements a file chooser callable from Poser’s Python interface.
Arguments
This method requires 4 Arguments:
• Type: Enter a Poser Dialog constant specifying either a File Open or File Save dialog
(such as kDialogFileChooserOpen).
• Parent: Specify the window to which the file chooser will be parented.
• Message: Enter the message to be displayed in the dialog.
• Start Directory: Specify the file that will be selected by default in the dialog.
Syntax
<DialogFileChooserType> DialogFileChooser(<IntType> type, <DialogType>
parentDialog, <StringType> message, <StringType> startDir)

DialogFileChooser Methods
249 Poser 11
PoserPython Methods Manual

Path
Explanation
Get the path specified by the user in the dialog.
Arguments
None
Syntax
<StringType> Path()

Show
Explanation
Brings up the File Chooser modal dialog.
Arguments
None
Syntax
<NoneType> Show()

DialogDirChooser Methods
This class of methods was introduced in Poser 7.0.0.

DialogDirChooser
Explanation
Implements a directory chooser callable from Poser’s Python interface.
Arguments
Specify the window to which the dialog will be parented, the specific message
text, and the directory that will be selected by default in the dialog.
Syntax
<DialogDirChooserType> DialogDirChooser(<DialogType> parentDialog,
<StringType> message, <StringType> startDir)

Path
Explanation
Get the path specified by the user in the dialog.
Arguments
None
Syntax
<StringType> Path()

Show
Explanation
Brings up the Directory Chooser dialog.
Arguments
None

DialogDirChooser Methods
250 Poser 11
PoserPython Methods Manual

Syntax
<NoneType> Show()

DialogTextEntry Methods
This class of methods was introduced in Poser 7.0.0.

DialogTextEntry
Explanation
Implements a simple (one-field) text entry dialog.
Arguments
Specify the window to which the dialog will be parented, and the message to be
displayed in the dialog.
Syntax
<DialogTextEntry> DialogTextEntry(<DialogType> parentDialog,
<StringType> message)

Show
Explanation
Brings up a text entry dialog.
Arguments
None
Syntax
<NoneType> Show()

Text
Explanation
Get the text entered by the user in the dialog.
Arguments
None
Syntax
<StringType> Text()

CredManager Methods
This class of methods was introduced in Poser Pro. poser.CredManager is a simple
manager for credentials (for example, a login to a web service). You can store user
name, and if desired, password for a service you name. You can retrieve it later to
connect to that service without repeatedly prompting for login information.

EnablePasswordSaving
Explanation
Sets desired state of saving passwords.

DialogTextEntry Methods
251 Poser 11
PoserPython Methods Manual

Arguments
Enter 1 to enable password saving, 0 to disable it.
Syntax
EnablePasswordSaving(<IntType> onOrOff)

FacebookAccessToken
Explanation
Get the access token of the saved Facebook account.
Arguments
None
Syntax
<StringType> FacebookAccessToken()

GetLastUser
Explanation
Get the username that was most recently saved for this service.
Arguments
Enter the name of the service as string.
Syntax
<StringType> GetLastUser(<StringType> service)

GetPassword
Explanation
Get the password for the specified service and user.
Arguments
Enter the name of the service and user as strings.
Syntax
GetPassword(<StringType> service,<StringType> user)

SaveFacebookToken
Explanation
Saves the Facebook access token for later use.
Arguments
None
Syntax
<NoneType> SaveFacebookToken(<StringType> token)

SavePassword
Explanation
Save the username and password for the specified service.
Arguments
Enter the name of the service, user, and its password as strings.

CredManager Methods
252 Poser 11
PoserPython Methods Manual

Syntax
SavePassword(<StringType> service,<StringType> user,<StringType>
password)

WantsPasswordSaved
Explanation
Returns desired state of saving passwords.
Arguments
None
Syntax
<IntType> WantsPasswordSaved()

CredManager Methods
253
Poser 11
PoserPython Methods Manual

Index
A AttachTreeNodes 187
Attributes 97
Actor 47, 133, 160
AutoGroupActor 134
ActorByInternalName 48, 133
AutoValue 198
Actors 48, 134
ActorType 33 B
AddAttribute 97
AddButtonCallback 247 BackfaceCull 100
AddClothActor 240 BackgroundColor 49
AddCollisionActor 240 BackgroundImage 49
AddCollisionFigure 240 BackgroundMovie 50
AddGeneralMesh 174 BackgroundShaderTree 50
AddKeyFrame 99, 160 Base 101
AddMaterialName 174 BendResistance 229
AddObjectRange 97 Bends 101
Addon command 5 Bitness 34
AddPolygon 175 BranchedPathTracing 217
AddTriangle 175 BucketSize 198, 218
AddValueOperation 160 BumpMapFileName 148
AddZone 161 BumpStrength 149
AirDamping 229
AlignmentRotationXYZ 99 C
AltGeomFileName 99 CalculateDynamics 229, 240
AmbientColor 148 Cameras 50
AmbientMapFileName 148 CanBeAnimated 194
AmbientOcclusion 99 CastShadows 101
AmbientOcclusionBias 99 Changed 50
AmbientOcclusionDistance 100 CheckFigureMagnets 134
AmbientOcclusionStrength 100 Children 101
AnimatableOrigin 100 ClampDirectSamples 218
Animated 194 ClampIndirectSamples 218
AnimSet 48 ClearCommands 34
AnimSets 49 ClearDynamics 241
Antialias 85 ClearEventCallback 50
AntialiasNow 49 ClearLocalTransformCallback 101
AOSamples 217 ClearSound 51
AppLocation 34 ClearStartupScript 51, 134
ApplyLimits 161 ClearTextureCache 34
ApplyMotionRig 134 ClearUpdateCallback 161
AppVersion 34 ClearVertexCallback 102
AskActor 246 ClearWorldspaceCallback 51
AskFloat 246 CloseDocument 35
AskInt 246 ClothSimulator 51
AskMenu 246 ClothSimulatorByName 51
AtmosphereShaderTree 49 Clumpiness 230
AtmosphereStrength 100 COLLADA Codes 9


254
Poser 11
PoserPython Methods Manual

CollisionsOn 230 DeleteKey 171

CommandNames 35 DeleteKeyFrame 103, 161
CompoundData 189 DeleteLayer 149
ConformTarget 135 DeleteNode 187
ConformTo 135 DeleteValueOperation 162
ConnectToInput 189, 245 Delta 172
ConstantAtFrame 161 Density 230
ContentRootLocation 35 DepthOfField 198, 218
ConvertToUniversalPose 135 DetachTreeNode 188
CopyJointParmsFrom 135 Device 218
CopyToClipboard 52 Devices 219
CreaseAngle 102 Dialog 248
CreateAnimSet 52 DialogDirChooser 249
CreateClothSimulator 52 DialogFileChooser 248
CreateFullBodyMorph 135 DialogSimple 37, 246
CreateGeomFromGroup 52 DialogTextEntry 250
CreateGrouping 52 DiffuseBounces 219
CreateHairGroup 102 DiffuseColor 149
CreateLayer 149 DiffuseSamples 219
CreateLight 53 Disconnect 194
CreateMagnet 53 Displacement 198
CreateNode 187 DisplacementBounds 103, 198
CreatePropFromGeom 53 DisplayStyle 56, 103, 136
CreateValueParameter 102 DocumentPath 56
CreateWave 53 DrapingFrames 241
CredManager 35 Draw 56
CurrentActor 53 DrawAll 56
CurrentCamera 54 DrawToonOutline 199
CurrentClothActor 241 DropToFloor 104, 136
CurrentCommand 35 DynamicsProperty 241
CurrentFigure 54
CurrentFireFlyOptions 54 E
CurrentLight 54 EnableParallelComputeActors 37
CurrentMaterial 54 EnableParallelHairCollision 37
CurrentMaterialLayer 55 EnablePasswordSaving 250
CurrentRenderEngine 55 EnableTriMeshPrecomputation 38
CurrentRoom 36 EndFrame 242
CurrentSuperFlyOptions 55 EndPoint 104
CustomData 102, 136 ExecFile 38
Export 94
D ExportOptions 95
DefineMaterialWacroButton 36 ExportOptionString 95
DefineProjGuideHTMLWidget 36 ExtName 149, 159
DefineProjGuideScriptButton 36 ExtraOutput 199
DefineScriptButton 37
Delete 103, 136, 190, 230, 241 F
DeleteAnimSet 55 FacebookAccessToken 251
DeleteCurrentFigure 55 Figure 57
DeleteCurrentProp 56 FigureByInternalName 57


255
Poser 11
PoserPython Methods Manual

FigureMeasure 136 HairGroup 105

Figures 57 HairProp 231
FileMetadata 38 HasKeyAtFrame 162
FilterGlossy 219 HDRIOutput 201
FilterSize 199 Hidden 162
FilterType 199 Hider 201
FireFlyOptions 57
FireFlyOptionsByName 57 I
FlashAutoPlay 86 IkNames 137
FlashDrawInnerLines 86 IkStatus 137
FlashDrawOuterLines 86 ImExporter 59
FlashLineWidth 86 Import 96
FlashNumColors 86 ImportOptions 96
FlashOverlapColors 87 ImportOptionString 96
FlashQuantizeAll 87 IncludeInGroup 183
FlashQuantizeFrame 87 IncludeMorphsWhenConforming 137
FlashQuantizeOne 87 IncludeScalesWhenConforming 138
Flavor 38 IncludeTranslationsWhenConforming
FollowOriginsWhenConforming 137  138
ForceLimits 162 InGroup 182
ForegroundColor 58 InitValue 162
Frame 58 InNode 195
FrameOptions 87 InOutput 195
FrameSelected 58 Input 190
FramesPerSecond 58 InputByInternalName 190
Inputs 190
G InputsCollapsed 190
Gamma 180, 201 InsertKey 172
Geometry 104 InternalName 105, 138, 163, 191, 195,
GeomFileName 58, 104, 137 245
GetKey 172 IsBase 105
GetLastUser 251 IsBodyPart 105
GetPassword 251 IsCamera 105
GIINtensity 199 IsClothActor 242
GIMaxError 200 IsCollisionActor 242
Gimbal 104 IsCollisionFigure 242
GINumBounces 200 IsControlProp 106
GINumSamples 200 IsDeformer 106
GIOnlyRender 200 IsFigure 106
GIPassScale 201 IsGameDev 38
GlossyBounces 219 IsHairProp 106
GlossySamples 220 IsLight 106
Gravity 230 IsMeasurement 107
GroundColor 59 IsMorphTarget 163
GroundShadows 59 IsParm 107
Groups 175, 182 IsPro 39
GrowHair 231 IsProp 107
IsRoot 191
H IsValueParameter 163


256
Poser 11
PoserPython Methods Manual

IsZone 107 KCmdCodeMATERIALROOM 24

ItsFigure 107 kCmdCodePANDPPALETTE 20
ItsNode 195, 245 KCmdCodePOSEROOM 24
KCmdCodeSETUPROOM 24
J kCmdCodeWALKPALETTE 20
JointVertexWeights 108 kCmdCodeZEROFIGURE 20
kDialogFileChooserOpen 10
K kDialogFileChooserSave 10
kDisplayCodeCARTOONNOLINE 11
kCBFrameChanged 30 kDisplayCodeEDGESONLY 11
kCBSceneChanged 30 kDisplayCodeFLATLINED 11
kCBValueChanged 30 kDisplayCodeFLATSHADED 11
kClothParmCodeAIRDAMPING 7 kDisplayCodeHIDDENLINE 11
kClothParmCodeCLOTHCLOTHFORCE kDisplayCodeSHADEDOUTLINED 11
 7 kDisplayCodeSILHOUETTE 11
kClothParmCodeCLOTHFRICTION 7 kDisplayCodeSKETCHSHADED 11
kClothParmCodeDAMPINGSTRETCH 7 kDisplayCodeSMOOTHLINED 11
kClothParmCodeDENSITY 7 kDisplayCodeSMOOTHSHADED 11
kClothParmCodeDYNAMICFRICTION 7 kDisplayCodeTEXTURELINED 11
kClothParmCodeFRICTIONFROMSOLID kDisplayCodeTEXTURESHADED 11
 7 KDisplayCodeUSEPARENTSTYLE 11
kClothParmCodeFRICTIONVELOCITYC- KDisplayCodeWIREFRAME 11
UTOFF 7 kEventCodeACTORADDED 30
kClothParmCodeSHEARRESISTANCE 7 kEventCodeACTORDELETED 30
kClothParmCodeSPRINGRESISTANCE 8 kEventCodeACTORSELECTION-
kClothParmCodeSTATICFRICTION 8 CHANGED 30
kClothParmCodeTHICKNESS 8 keventCodeANIMSETSCHANGED 30
kClothParmCodeUBENDRATE 8 kEventCodeITEMRENAMED 30
kClothParmCodeUBENDRESISTANCE 8 kEventCodeKEYSCHANGED 30
kClothParmCodeUSCALE 8 kEventCodePARMADDED 30
kClothParmCodeUSEEDGESPRINGS 8 kEventCodePARMCHANGED 31
kClothParmCodeUSTRETCHRESIS- kEventCodePARMDELETED 31
TANCE 8 kEventCodeSCENECLOSING 31
kClothParmCodeVBENDRATE 8 kEventCodeSETUPMODE 31
kClothParmCodeVBENDRESISTANCE 8 kExOptCodeASMORPHTARGET 14
kClothParmCodeVSCALE 8 kExOptCodeAUTOSCALE 14
kClothParmCodeVSTRETCHRESIS- kExOptCodeBODYPARTNAMESINPOLY-
TANCE 8 GROUPS 14
kCmdCodeANIMATIONPALETTE 19 kExOptCodeBROADCASTKEY 14
kCmdCodeAPPLYBULGES 19 kExOptCodeCOLLADABakeDiffuse-
kCmdCodeCLOTHESROOM 24 Map 9
KCmdCodeCLOTHROOM 24 kExOptCodeCOLLADABakeTran-
KCmdCodeCONTENTROOM 24 parencyMap 9
KCmdCodeFACEOOM 24 kExOptCodeCOLLADAConformEvery-
kCmdCodeFITTINGROOM 24 Frame 9
kCmdCodeGROUPPALETTE 19 kExOptCodeCOLLADACustomUnit-
KCmdCodeHAIRROOM 24 Name 9
kCmdCodeJOINTPALETTE 19 kExOptCodeCOLLADAExportTriangles
kCmdCodeLIBRARYPALETTE 19  9
kCmdCodeLIBRARYPALETTEFIGURES19


257
Poser 11
PoserPython Methods Manual

kExOptCodeCOLLADAFreezeFigMesh kHiderRayTrace 15
 9 kHiderREYES 15
kExOptCodeCOLLADAImportAnima- kImOptCodeARMALIGNMENTAXIS 15
tion 9 kImOptCodeAUTOSCALE 15
kExOptCodeCOLLADAIncludeNormals kImOptCodeCENTERED 15
 9 kImOptCodeCOLLADAImportCam-
kExOptCodeCOLLADAIsCustomUnit 9 eras 10
kExOptCodeCOLLADALimitTextureSize kImOptCodeCOLLADAImportLights 10
 9 kImOptCodeFLIPNORMS 15
kExOptCodeCOLLADAMaxTextureSize kImOptCodeFLIPUTEXTCOORDS 15
 9 kImOptCodeFLIPVTEXTCOORDS 15
kExOptCodeCOLLADAMorphOption 9 kImOptCodeMAKEPOLYNORMSCON-
kExOptCodeCOLLADAPercentageS- SISTENT 16
cale 10 kImOptCodeOFFSETX 16
kExOptCodeCOLLADAPoserUnitScale- kImOptCodeOFFSETY 16
Custom 10 kImOptCodeOFFSETZ 16
kExOptCodeCOLLADAPoserUnitScal- kImOptCodePERCENTFIGSIZE 16
eFactorType 10 kImOptCodePLACEONFLOOR 16
kExOptCodeCOLLADAPresetName 10 kImOptCodeSCALEABSOLUTE 16
kExOptCodeCOLLADATexureSizePow- kImOptCodeWELDIDENTICALVERTS 16
erof2 10 KinkDelay 231
kExOptCodeCOLLADATranparency- KinkScale 231
Map 10 KinkStrength 231
kExOptCodeCOLLADATransparentTy- kLanguageCodeFRENCH 16
peRGB 10 kLanguageCodeGERMAN 16
kExOptCodeCOLLADAUpAxis 10 kLanguageCodeJAPANESE 16
kExOptCodeCOLLADAUseCultureIn- kLanguageCodeUSENGLISH 16
variantName 10 kLightCodeAREA 16
kExOptCodeEXISTINGGROUPSINPOLY- kLightCodeIMAGE 17
GROUPS 14 kLightCodeINFINITE 17
kExOptCodeFIGNAMESINGROUPS 14 kLightCodeINVLINEARATTEN 17
kExOptCodeFIRSTFRAME 14 kLightCodeINVSQUAREATTEN 17
kExOptCodeGENERATEHTML 14 kLightCodeLOCAL 17
kExOptCodeGEOMQUALITY 14 kLightCodePOINT 17
kExOptCodeGROUPSPERBODYPART14 kLightCodePOSERATTEN 17
kExOptCodeHTMLVIEWPORTHEIGHT 14 kLightCodeSPOT 17
kExOptCodeHTMLVIEWPORTWIDTH 14 kMetadataProperty_dc_relation 18
kExOptCodeIGNORECAMERAANIM 14 kMetadataProperty_poser_fileSigna-
kExOptCodeIMAGEQUALITY 14 ture 19
kExOptCodeLASTFRAME 14 kNodeInputCodeBOOLEAN 29
kExOptCodeMULTIFRAME 14 kNodeInputCodeCOLOR 29
kExOptCodePERCENTSCALE 15 kNodeInputCodeFLOAT 29
kExOptCodeSAVECOMPRESSED 15 kNodeInputCodeINTEGER 29
kExOptCodeSCALEFACTOR 15 kNodeInputCodeMENU 29
kExOptCodeSOFTEDGESINHTML 15 kNodeInputCodeNONE 29
kExOptCodeUSEANIMSETS 15 kNodeInputCodeSTRING 29
kExOptCodeUSEINTERNALNAMES 15 kNodeInputCodeVECTOR 29
kExOptCodeUSEWAVELETTEXTURES 15 kNodeTypeCodeAMBIENTOCCLUSION
kExOptCodeWELDSEAMS 15  25


258
Poser 11
PoserPython Methods Manual

kNodeTypeCodeANISOTROPIC 25 kNodeTypeCodeSCATTERSKIN 28
kNodeTypeCodeATMOSPHERE 25 kNodeTypeCodeSIMPLECOLOR 28
kNodeTypeCodeBACKGROUND 25 kNodeTypeCodeSKIN 28
kNodeTypeCodeBLENDER 25 kNodeTypeCodeSPECULAR 28
kNodeTypeCodeBLINN 25 kNodeTypeCodeSPHEREMAP 28
kNodeTypeCodeBRICK 25 kNodeTypeCodeSPOTS 28
kNodeTypeCodeCELLULAR 25 kNodeTypeCodeTILE 28
kNodeTypeCodeCLAY 25 kNodeTypeCodeTOON 28
kNodeTypeCodeCLOUDS 25 kNodeTypeCodeTURBULENCE 28
kNodeTypeCodeCOLORMATH 25 kNodeTypeCodeU 28
kNodeTypeCodeCOLORRAMP 25 kNodeTypeCodeUSERDEFINED 28
kNodeTypeCodeCOMP 25 kNodeTypeCodeV 29
kNodeTypeCodeCOMPOUND 25 kNodeTypeCodeVELVET 29
kNodeTypeCodeCUSTOMSCATTER 26 kNodeTypeCodeVOLUME 29
kNodeTypeCodeDIFFUSE 26 kNodeTypeCodeWAVE2D 29
kNodeTypeCodeDNDU 26 kNodeTypeCodeWAVE3D 29
kNodeTypeCodeDNDV 26 kNodeTypeCodeWEAVE 29
kNodeTypeCodeDPDU 26 kNodeTypeCodeWOOD 29
kNodeTypeCodeDPDV 26 kOutlineCodeMEDIUMMARKER 12
kNodeTypeCodeDU 26 kOutlineCodeMEDIUMPEN 12
kNodeTypeCodeDV 26 kOutlineCodeMEDIUMPENCIL 12
kNodeTypeCodeEDGEBLEND 26 kOutlineCodeTHICKMARKER 12
kNodeTypeCodeFASTSCATTER 26 kOutlineCodeTHICKPEN 12
kNodeTypeCodeFBM 26 kOutlineCodeTHICKPENCIL 12
kNodeTypeCodeFRACTALSUM 26 kOutlineCodeTHINMARKER 12
kNodeTypeCodeFRAME 26 kOutlineCodeTHINPEN 12
kNodeTypeCodeFRESNEL 26 kOutlineCodeTHINPENCIL 12
kNodeTypeCodeFRESNELBLEND 26 kParmCodeASCALE 20
kNodeTypeCodeGAMMA 26 kParmCodeCENTER 20
kNodeTypeCodeGATHER 27 KParmCodeCLOTHDYNAMICS 20
kNodeTypeCodeGLOSSY 27 kParmCodeCURVE 20
kNodeTypeCodeGRANITE 27 kParmCodeDEFORMERPROP 20
kNodeTypeCodeHAIR 27 kParmCodeDEPTHMAPSIZE 20
kNodeTypeCodeHSV 27 kParmCodeDEPTHMAPSTRENGTH 20
kNodeTypeCodeHSV2 27 kParmCodeDYNAMICPARENT 20
kNodeTypeCodeIMAGEMAP 27 kParmCodeFOCAL 20
kNodeTypeCodeLIGHT 27 kParmCodeFOCUSDISTANCE 20
kNodeTypeCodeMARBLE 27 kParmCodeFSTOP 21
kNodeTypeCodeMATH 27 kParmCodeGEOMCHAN 21
kNodeTypeCodeMOVIE 27 kParmCodeGRASP 21
kNodeTypeCodeN 27 KParmCodeHAIRDYNAMICS 21
kNodeTypeCodeNOISE 27 kParmCodeHITHER 21
kNodeTypeCodeP 27 kParmCodeKDBLUE 21
kNodeTypeCodePHONG 27 kParmCodeKDGREEN 21
kNodeTypeCodePOSERSURFACE 28 kParmCodeKDINTENSITY 21
kNodeTypeCodePROBELIGHT 28 kParmCodeKDRED 21
kNodeTypeCodeREFLECT 28 kParmCodeLITEATTENEND 21
kNodeTypeCodeREFRACT 28 kParmCodeLITEATTENSTART 21
kNodeTypeCodeSCATTER 28 kParmCodeLITEFALLOFFEND 21


259
Poser 11
PoserPython Methods Manual

kParmCodeLITEFALLOFFSTART 21 kTIFF_ADOBE_DEFLATE 24
kParmCodePOINTAT 21 kTIFF_DEFAULT 24
kParmCodeSHUTTERCLOSE 21 kTIFF_DEFLATE 24
kParmCodeSHUTTEROPEN 22 kTIFF_JPEG 24
kParmCodeSOFTDYNAMICS 22 kTIFF_LZW 24
kParmCodeSPREAD 22 kTIFF_NONE 24
kParmCodeTAPERX 22 kTIFF_PACKBITS 25
kParmCodeTAPERY 22 kValueOpTypeCodeDELTAADD 31
kParmCodeTAPERZ 22 kValueOpTypeCodeDIVIDEBY 31
kParmCodeTARGET 22 kValueOpTypeCodeDIVIDEINTO 31
kParmCodeTGRASP 22 kValueOpTypeCodeKEY 31
kParmCodeVALUE 22 kValueOpTypeCodeMINUS 31
kParmCodeWAVEAMPLITUDE 22 kValueOpTypeCodePLUS 31
kParmCodeWAVEAMPLITUDENOISE 22 kValueOpTypeCodePYTHONCALL-
kParmCodeWAVEFREQUENCY 22 BACK 31
kParmCodeWAVELENGTH 22 kValueOpTypeCodeTIMES 31
kParmCodeWAVEOFFSET 22 kZoneTypeCodeCAPSULE 31
kParmCodeWAVEPHASE 22 kZoneTypeCodeMERGEDWEIGHTMAP
kParmCodeWAVESINUSOIDAL 23  31
kParmCodeWAVESQUARE 23 kZoneTypeCodeSPHERE 32
kParmCodeWAVESTRETCH 23 kZoneTypeCodeWEIGHTMAP 32
kParmCodeWAVETRIANGULAR 23
kParmCodeWAVETURBULENCE 23 L
kParmCodeXROT 23 Language 39
kParmCodeXSCALE 23 Layer 150
kParmCodeXTRAN 23 LayerByExtName 150
kParmCodeYON 23 LayerByName 150
kParmCodeYROT 23 LayerExtName 150
kParmCodeYSCALE 23 LayerName 150
kParmCodeYTRAN 23 Layers 151
kParmCodeZROT 23 LayerShaderTree 151
kParmCodeZSCALE 23 LayerShaderTreeHash 151
kParmCodeZTRAN 23 LeakMemory 39
kPixelFilterCodeBOX 12 LengthMax 232
kPixelFilterCodeGAUSS 12 LengthMin 232
kPixelFilterCodeSINC 12 Libraries 39
kRayAcceleratorCodeDEFAULT 12 LightAttenType 108
KRayAcceleratorCodeHBVO 12 LightOn 108
KRayAcceleratorCodeKDTREE 13 Lights 59
KRayAcceleratorCodeVOXEL 13 LightType 108
kRenderEngineCodeFIREFLY 13 LinearAtFrame 163
kRenderEngineCodePREVIEW 13 LoadLibraryCamera 59
kRenderEngineCodeSKETCH 13 LoadLibraryFace 60
kRenderEngineCodeSUPERFLY 13 LoadLibraryFigure 60
kSkinTypePoser 186 LoadLibraryHair 60
kSkinTypeUnimeshLinear 186 LoadLibraryHand 61
kSkinTypeUnimeshPoser 187 LoadLibraryLight 61
KTextureCompressorCodeRLE 13 LoadLibraryPose 61
KTextureCompressorCodeZIP 13 LoadLibraryProp 61


260
Poser 11
PoserPython Methods Manual

LoadMaterialCollection 108 NewGeometry 40

LoadMaterialSet 151 NewMotionRig 40
LoadMorphTargetFile 109 NextKeyFrame 63, 111, 164
LoadPreset 201 NextKeyFrameAll 63
LocalDisplacement 109 Node 188
LocalMatrix 109 NodeByInternalName 188
LocalQuaternion 109 Nodes 188
Location 191 Normals 176
Ns 152
M NumBodyParts 63
MainWindow 39 NumbPopHairs 232
MakeFlash 88 NumbSubdivLevels 111, 139
MakeMovie 88 NumbSubdivRenderLevels 111, 140
Manual 202 NumBumpMaps 63
MarkGeomChanged 109 NumbVertsPerHair 232
MatchEndpointsWhenConforming 138 NumCameras 63
Material 110, 138 NumClothSimulators 64
MaterialIndex 183 NumFigures 64
MaterialName 183 NumFrames 64
Materials 110, 139, 175 NumGeometries 64
MaxBounces 220 NumHairGroups 111
MaxError 202 NumIkChains 139
MaxRayDepth 202 NumImageMaps 64
MaxSampleSize 202 NumInputs 191
MaxTextureRes 202 NumKeys 172
MaxTransparentBounces 220 NumLayers 152
MaxValue 164 NumLights 65
Measurements 62 NumMaterials 176
MeasurementValue 110 NumMorphTargetDeltas 165
Memorize 110, 139 NumNodes 188
MemorizeAll 62 NumNormals 176
MemorizeLights 62 NumOutputs 192
MeshLightSamples 220 NumPolygons 176
MessageBox 247 NumProps 65
MinBounces 220 NumRenderThreads 40
MinShadingRate 203 NumSets 176
MinTransparentBounces 221 NumTexPolygons 177
MinValue 164 NumTexSets 177
MorphFiles 62 NumTexVertices 177, 185
MorphTargetDelta 164 NumValueOperations 165
MotionBlur 88, 203, 221 NumVertices 177, 183
MovieFormat 88
MovieMaker 62
O
MovieRenderer 89 ObjectRange 98
OnOff 112
N OpenDocument 40
Name 111, 139, 151, 159, 164, 191, 195, Orientation 112
232, 242, 245 Origin 112
NewDocument 40 Output 192


261
Poser 11
PoserPython Methods Manual

OutputByInternalName 192 RayTraceShadows 113

OutputEndFrame 89 RayTracing 203
OutputFormats 89 Redo 42
OutputRange 65 ReducePolys 178
OutputRes 65, 89 ReflectionColor 152
Outputs 192 ReflectionMapFileName 152
OutputStartFrame 89 ReflectionStrength 152
ReflectiveCaustics 221
P RefractiveCaustics 222
PaletteById 41 RegisterAddon 42
Palettes 41 RemoveAttribute 98
Parameter 112, 172 RemoveBackfacing 204
ParameterByCode 112 RemoveClothActor 243
Parameters 98, 113, 196 RemoveCollisionActor 243
Parent 113 RemoveCollisionFigure 243
ParentActor 140 RemoveFromGroup 184
Path 249 RemoveObjectRange 98
PickImage 247 RemoveValueParameter 114
PixelSamples 203, 221 Render 66
PmdDiff 65 RenderAntiAliased 66
PointAt 113 RenderBumpMaps 67
Polygon 177 RenderCastShadows 67
Polygons 178 RenderDimAutoscale 67
PoserPython RendererRootNode 189
Basic structure 3 RenderIgnoreShaderTrees 67
Folder syntax 4 RenderInBackground 67
Methods Manual (opening) 5 RenderInSeparateProcess 42, 46
Running scripts 4 RenderOnBGColor 68
Sample script 3 RenderOnBGPict 68
Writing scripts 4 RenderOnBlack 68
PositionForce 233 RenderOverType 68
PrefsLocation 41, 46 RenderTextureMaps 68
PreviewCollapsed 192 RenderToNewWindow 69
PreviewRenderEngineType 41 RenderToQueue 69
PrevKeyFrame 66, 113, 165 Reset 114, 140
PrevKeyFrameAll 66 Resolution 69
ProcessCommand 42 ResolutionScale 69
ProcessSomeEvents 66 ResolvePendingTextures 69
ProgressiveRefinement 221 Restore 114, 140
PullBack 233 RestoreAll 70
PullDown 233 RestoreLights 70
PullLeft 233 RevertDocument 43
Rooms 43
Q RootStiffness 233
RootStiffnessFalloff 234
Quit 42 RootWidth 234
R S
RayAccelerator 203 SampleAllLightsDirect 222


262
Poser 11
PoserPython Methods Manual

SampleAllLightsIndirect 222 SetBucketSize 204, 223

SaveDocument 43 SetBumpMapFileName 153
SaveFacebookToken 251 SetBumpStrength 154
SaveImage 70 SetButtonValue 248
SaveLibraryCamera 70 SetCastShadows 117
SaveLibraryFace 71 SetChanged 75
SaveLibraryFigure 71 SetCheckZeroMorphs 44
SaveLibraryHair 71 SetClampDirectSamples 223
SaveLibraryHand 72 SetClampIndirectSamples 223
SaveLibraryLight 72 SetClumpiness 234
SaveLibraryPose 72 SetCollisionsOn 235
SaveLibraryProp 73 SetColor 196
SaveMaterialCollection 114 SetConformTarget 140
SaveMaterialSet 153 SetCreaseAngle 117
SavePassword 251 SetCurrentCamera 75
SavePrefs 43 SetCurrentClothActor 243
SavePreset 204 SetCurrentLight 75
ScaleMatrix 115 SetCurrentRenderEngine 75
Scene 43 SetCurrentRoom 44
SceneBBox 73 SetCustomData 117, 141
ScriptLocation 44 SetDelta 173
SelectActor 73 SetDensity 235
Selected 153 SetDepthOfField 204, 223
SelectedOutput 193 SetDevice 223
SelectFigure 73 SetDiffuseBounces 224
SelectMaterial 73 SetDiffuseColor 154
SelectMaterialLayer 74 SetDiffuseSamples 224
Sensitivity 165 SetDisplacement 205
SetAirDamping 234 SetDisplacementBounds 117, 205
SetAlignmentRotationXYZ 115 SetDisplayOrigin 117
SetAmbientColor 153 SetDisplayStyle 76, 118, 141
SetAmbientMapFileName 153 SetDrapingFrames 243
SetAmbientOcclusion 115 SetDrawToonOutline 205
SetAmbientOcclusionBias 115 SetDynamicsProperty 244
SetAmbientOcclusionDistance 115 SetEndFrame 244
SetAmbientOcclusionStrength 116 SetEndPoint 118
SetAnimatableOrigin 116 SetEventCallback 76
SetAnimated 196 SetExtraOutput 205
SetAntialias 90 SetFileMetadata 44
SetAOSamples 222 SetFilterGlossy 224
SetAtmosphereStrength 116 SetFilterSize 206
SetAutoValue 204 SetFilterType 206
SetBackfaceCull 116 SetFlashAutoPlay 90
SetBackgroundColor 74 SetFlashDrawInnerLines 90
SetBackgroundImage 74 SetFlashDrawOuterLines 90
SetBackgroundMovie 74 SetFlashLineWidth 91
SetBendResistance 234 SetFlashNumColors 91
SetBends 116 SetFlashOverlapColors 91
SetBranchedPathTracing 222 SetFlashQuantizeAll 91


263
Poser 11
PoserPython Methods Manual

SetFlashQuantizeFrame 92 SetMatchEndpointsWhenConforming
SetFlashQuantizeOne 92  142
SetFloat 196 SetMaterialIndex 184
SetFollowOriginsWhenConforming 141 SetMaterialName 184
SetForceLimits 165 SetMaxBounces 225
SetForegroundColor 76 SetMaxError 208
SetFrame 76 SetMaxRayDepth 208
SetFrameOptions 92 SetMaxSampleSize 209
SetGamma 180, 206 SetMaxTextureRes 209
SetGeometricOutline 77 SetMaxTransparentBounces 225
SetGeometricOutlineWelding 77 SetMaxValue 166
SetGeometry 118 SetMeAsStartupScript 78, 142
SetGIIntensity 206 SetMeshLightSamples 225
SetGIMaxError 206 SetMinBounces 225
SetGINumBounces 207 SetMinShadingRate 209
SetGINumSamples 207 SetMinTransparentBounces 225
SetGIOnlyRender 207 SetMinValue 166
SetGIPassScale 207 SetMorphTargetDelta 167
SetGlossyBounces 224 SetMotionBlur 92, 209, 226
SetGlossySamples 224 SetMovieFormat 93
SetGravity 235 SetMovieRenderer 93
SetGroundColor 77 SetName 120, 143, 167, 193, 196, 236,
SetGroundShadows 77 244, 245
SetHDRIOutput 208 SetNs 154
SetHidden 166 SetNumbPopHairs 236
SetHider 208 SetNumbSubdivLevels 120, 143
SetIkStatus 141 SetNumbSubdivRenderLevels 120, 143
SetIncludeInBoundingBox 118 SetNumbVertsPerHair 237
SetIncludeMorphsWhenConforming SetNumFrames 78
 142 SetNumRenderThreads 45
SetIncludeScalesWhenConforming142 SetOnOff 121, 143
SetIncludeTranslationsWhenConform- SetOrientation 121
ing 142 SetOrigin 121
SetInitValue 166 SetOutputEndFrame 93
SetInputsCollapsed 193 SetOutputRange 78
SetInternalName 166 SetOutputRes 78, 93
SetKinectRotMatrix 119 SetOutputResScale 94
SetKinkDelay 235 SetOutputStartFrame 94
SetKinkScale 235 SetParallelComputeActorsThread-
SetKinkStrength 236 Count 45
SetLanguage 44 SetParallelHairCollisionThreadCount 45
SetLengthMax 236 SetParameter 121
SetLengthMin 236 SetParent 122
SetLightAttenType 119 SetParentActor 143
SetLightOn 119 SetPixelSamples 209, 226
SetLightType 119 SetPositionForce 237
SetLocalTransformCallback 120 SetPreviewCollapsed 193
SetLocation 193 SetPreviewRenderEngineType 45
SetManual 208 SetProgressiveRefinement 226


264
Poser 11
PoserPython Methods Manual

SetPullBack 237 SetShowPopulated 238

SetPullDown 237 SetSkinType 144
SetPullLeft 237 SetSmoothPolys 125, 211
SetRangeConstant 122, 167 SetSound 82
SetRangeLinear 122, 167 SetSoundRange 82
SetRangeSpline 123, 168 SetSourceParameter 173
SetRayAccelerator 210 SetSpecularColor 155
SetRayTraceShadows 123 SetSplineBreak 125, 168
SetRayTracing 210 SetSpringDamping 238
SetReflectionColor 154 SetSpringStrength 239
SetReflectionMapFileName 155 SetStartFrame 244
SetReflectionStrength 155 SetStartupScript 83, 144
SetReflectiveCaustics 226 SetStatic 125
SetRefractiveCaustics 226 SetStrength 173
SetRemoveBackfacing 210 SetString 197
SetRenderAntiAliased 79 SetSubdivideWithFigure 125
SetRenderBumpMaps 79 SetSubsurfaceSamples 227
SetRenderCastShadows 79 SetText 248
SetRenderDimAutoscale 79 SetTextureCacheCompression 211
SetRendererRootNode 189 SetTextureCacheSize 211
SetRenderIgnoreShaderTrees 80 SetTextureColor 156
SetRenderInSeparateProcess 45, 46 SetTextureFiltering 211
SetRenderOnBGColor 80 SetTextureMapFileName 156
SetRenderOnBGPict 80 SetTipWidth 239
SetRenderOnBlack 80 SetToneExposure 212
SetRenderOverType 81 SetToneGain 212
SetRenderTextureMaps 81 SetToneMapper 212
SetRenderToNewWindow 81 SetToonOutlineStyle 212
SetResolution 81 SetTransmissionBounces 227
SetResolutionScale 82 SetTransmissionSamples 227
SetRootStiffness 238 SetTransparencyExpo 156
SetRootStiffnessFalloff 238 SetTransparencyMapFileName 156
SetRootWidth 238 SetTransparencyMax 157
Sets 178 SetTransparencyMin 157
SetSampleAllLightsDirect 227 SetU 185
SetSampleAllLightsIndirect 227 SetUpdateCallback 168
SetSelected 155 SetUseGamma 213
SetSelectedOutput 194 SetUseGI 212
SetSensitivity 168 SetUseIrradianceCache 213
SetShadingRate 123 SetUseOcclusionCulling 213
SetShadow 123 SetUseSceneGamma 181
SetShadowBiasMax 124 SetUseSSS 213
SetShadowBiasMin 124 SetUseTextureCache 213
SetShadowBlurRadius 124 SetV 186
SetShadowColor 82 SetValue 169
SetShadowOnlyRender 210 SetValueFrame 169
SetShadowRaytraceSoftness 124 SetVertexCallback 126
SetShadows 210 SetVisible 126, 144
SetShadowSamples 123 SetVisibleInCamera 126


265
Poser 11
PoserPython Methods Manual

SetVisibleInIDL 126 SubsurfaceSamples 228

SetVisibleInReflections 127 SwapBottom 145
SetVisibleInRender 127 SwapTop 146
SetVolumeBounces 228 SymmetryBotLeftToRight 146
SetVolumeSamples 228 SymmetryBotRightToLeft 146
SetWantsConform 169 SymmetryLeftToRight 146
SetWorldspaceCallback 83 SymmetryRightToLeft 147
SetWriteBinaryMorphs 46 SymmetryTopLeftToRight 147
SetX 181 SymmetryTopRightToLeft 147
SetY 181
SetZ 181 T
ShaderTree 157, 159 TempLocation 46
ShaderTreeHash 157, 160 TexPolygons 178
ShadingRate 127 TexSets 178
Shadow 127 Text 250
ShadowBiasMax 127 Texture 197
ShadowBiasMin 128 TextureCacheCompression 214
ShadowBlurRadius 128 TextureCacheSize 215
ShadowColor 83 TextureColor 158
ShadowOnlyRender 214 TextureFiltering 215
ShadowRaytraceSoftness 128 TextureMapFileName 158
Shadows 214 TexVertices 179, 185
ShadowSamples 128 TipWidth 240
Show 249, 250 ToneExposure 215
ShowFrameRate 46 ToneGain 215
ShowPopulated 239 ToneMapper 215
SkinType 144 ToonOutlineStyle 216
SmoothPolys 128, 214 TransmissionBounces 228
Sound 84 TransmissionSamples 228
SoundRange 84 TransparencyExpo 158
SourceParameter 173 TransparencyMapFileName 158
SpawnTarget 129 TransparencyMax 158
SpawnTargetFromGeometry 129 TransparencyMin 159
SpecularColor 157 TwistVertexWeights 130
SplineAtFrame 169 Type 174, 194, 197
SplineBreakAtFrame 170 TypeCode 170
SplitMorphLeftRight 170
SpringDamping 239 U
SpringStrength 239
Start 184, 185 U 186
StartFrame 244 UnaffectedValue 170
StartupScript 84, 145 Undo 46
Static 129 UnimeshInfo 147
StraightenBody 145 UpdateBGPreview 84
Strength 173 UpdatePreview 189
StringResource 46 UseGamma 216
StripRig 145 UseGI 216
SubdivGeometry 129, 145 UseIrradianceCache 216
SubdivideWithFigure 130 UseOcclusionCulling 216
UseSceneGamma 180


266
Poser 11
PoserPython Methods Manual

UseSSS 217 Z
UseTextureCache 217
Z 182
V ZeroMorphs 133
Zones 133
V 186
Value 170, 197
ValueFrame 171
ValueOperations 171
ValueParameter 130
ValueParameters 130
Version 47
Vertex 179
Vertices 179, 184
Visible 131, 148
VisibleInCamera 131
VisibleInIDL 131
VisibleInReflections 131
VisibleInRender 131
VolumeBounces 229
VolumeSamples 229

W
WacroLights 84
WacroMaterialLayers 85
WacroMaterials 85
WantsConform 171
WantsPasswordSaved 252
Weld 179
WeldGoalActors 132
WeldGoals 132
WorldDisplacement 132
WorldMatrix 132
WorldNormals 179
WorldQuaternion 132
WorldToScreen 85
WorldVertex 180
WorldVertices 180
WriteBinaryMorphs 34, 47
WxApp 47
WxAuiManager 47
wxPython 4

X
X 182

Y
Y 182
YesNo 247