Home       Trees       Index       Help   

Blender

Module Object :: Class Property
[frames | no frames]

Class Property

The Property object

This property gives access to object property data in Blender.

Warning: Comparisons between properties will only be true when both the name and data pairs are the same.

Method Summary
string, int, or float getData()
Get the data for this property.
string getName()
Get the name of this property.
int getPIDeflection()
Get the Object's Particle Interaction Deflection Setting.
float getPIFalloff()
Get the Object's Particle Interaction falloff.
float getPIMaxDist()
Get the Object's Particle Interaction MaxDist.
float getPIPermf()
Get the Object's Particle Interaction Permiability.
float getPIRandomDamp()
Get the Object's Particle Interaction RandomDamp.
float getPIStregth()
Get the Object's Particle Interaction Strength.
float getPISurfaceDamp()
Get the Object's Particle Interaction SurfaceDamp.
int getPIType()
Get the Object's Particle Interaction Type.
int getPIUseMaxDist()
Get the Object's Particle Interaction if using MaxDist.
float getSBDefaultGoal()
Get the Object's SB DefaultGoal.
int getSBEnable()
Get if the Object's SB is Enabled.
float getSBErrorLimit()
Get the Object's SB ErrorLimit.
float getSBFriction()
Get the Object's SB Friction.
float getSBGoalFriction()
Get the Object's SB GoalFriction.
float getSBGoalSpring()
Get the Object's SB GoalSpring.
float getSBGravity()
Get the Object's SB Gravity.
float getSBInnerSpring()
Get the Object's SB InnerSpring.
float getSBInnerSpringFriction()
Get the Object's SB InnerSpringFriction.
float getSBMass()
Get the Object's SB Mass.
float getSBMaxGoal()
Get the Object's SB MaxGoal.
float getSBMinGoal()
Get the Object's SB MinGoal.
int getSBPostDef()
get Softbodies PostDef option
int getSBStiffQuads()
get Softbodies StiffQuads option
int getSBUseEdges()
get Softbodies UseEdges option
int getSBUseGoal()
get Softbodies UseGoal option
string getType()
Get the type for this property.
  setData(data)
Set the data for this property.
  setName(name)
Set the name of this property.
PyNone setPIDeflection(status)
Set the the Object's Particle Interaction Deflection Setting.
PyNone setPIFalloff(falloff)
Set the the Object's Particle Interaction falloff.
PyNone setPIMaxDist(MaxDist)
Set the the Object's Particle Interaction MaxDist.
PyNone setPIPerm(perm)
Set the the Object's Particle Interaction Permiability.
PyNone setPIRandomDamp(damp)
Set the the Object's Particle Interaction RandomDamp.
PyNone setPIStrength(strength)
Set the the Object's Particle Interaction Strength.
PyNone setPISurfaceDamp(damp)
Set the the Object's Particle Interaction SurfaceDamp.
PyNone setPIType(type)
Set the the Object's Particle Interaction type.
PyNone setPIUseMaxDist(status)
Set the the Object's Particle Interaction MaxDist.
PyNone setSBDefaultGoal(goal)
Set the the Object's SB DefaultGoal.
PyNone setSBEnable(switch)
Enable / Disable Softbodies.
PyNone setSBErrorLimit(err)
Set the the Object's SB ErrorLimit.
PyNone setSBFriction(frict)
Set the the Object's SB Friction.
PyNone setSBGoalFriction(gf)
Set the the Object's SB GoalFriction.
PyNone setSBGoalSpring(gs)
Set the the Object's SB GoalSpring.
PyNone setSBGravity(grav)
Set the the Object's SB Gravity.
PyNone setSBInnerSpring(sprr)
Set the the Object's SB InnerSpring.
PyNone setSBInnerSpringFriction(sprf)
Set the the Object's SB InnerSpringFriction.
PyNone setSBMass(mass)
Set the the Object's SB Mass.
PyNone setSBMaxGoal(mg)
Set the the Object's SB MaxGoal.
PyNone setSBMinGoal(mg)
Set the the Object's SB MinGoal.
PyNone setSBPostDef(switch)
Enable / Disable Softbodies PostDef option 1: on 0: off
PyNone setSBStiffQuads(switch)
Enable / Disable Softbodies StiffQuads option 1: on 0: off
PyNone setSBUseEdges(switch)
Enable / Disable Softbodies UseEdges option 1: on 0: off
PyNone setSBUseGoal(switch)
Enable / Disable Softbodies UseGoal option 1: on 0: off

Class Variable Summary
  data: Data for this property.
  name: The property name.
  type: The property type.

Method Details

getData()

Get the data for this property.
Returns:
string, int, or float

getName()

Get the name of this property.
Returns:
The property name.
           (type=string)

getPIDeflection()

Get the Object's Particle Interaction Deflection Setting.
Returns:
int

getPIFalloff()

Get the Object's Particle Interaction falloff.
Returns:
float

getPIMaxDist()

Get the Object's Particle Interaction MaxDist.
Returns:
float

getPIPermf()

Get the Object's Particle Interaction Permiability.
Returns:
float

getPIRandomDamp()

Get the Object's Particle Interaction RandomDamp.
Returns:
float

getPIStregth()

Get the Object's Particle Interaction Strength.
Returns:
float

getPISurfaceDamp()

Get the Object's Particle Interaction SurfaceDamp.
Returns:
float

getPIType()

Get the Object's Particle Interaction Type.
Returns:
int

getPIUseMaxDist()

Get the Object's Particle Interaction if using MaxDist.
Returns:
int

getSBDefaultGoal()

Get the Object's SB DefaultGoal.
Returns:
float

getSBEnable()

Get if the Object's SB is Enabled.
Returns:
int

getSBErrorLimit()

Get the Object's SB ErrorLimit.
Returns:
float

getSBFriction()

Get the Object's SB Friction.
Returns:
float

getSBGoalFriction()

Get the Object's SB GoalFriction.
Returns:
float

getSBGoalSpring()

Get the Object's SB GoalSpring.
Returns:
float

getSBGravity()

Get the Object's SB Gravity.
Returns:
float

getSBInnerSpring()

Get the Object's SB InnerSpring.
Returns:
float

getSBInnerSpringFriction()

Get the Object's SB InnerSpringFriction.
Returns:
float

getSBMass()

Get the Object's SB Mass.
Returns:
float

getSBMaxGoal()

Get the Object's SB MaxGoal.
Returns:
float

getSBMinGoal()

Get the Object's SB MinGoal.
Returns:
float

getSBPostDef()

get Softbodies PostDef option
Returns:
int

getSBStiffQuads()

get Softbodies StiffQuads option
Returns:
int

getSBUseEdges()

get Softbodies UseEdges option
Returns:
int

getSBUseGoal()

get Softbodies UseGoal option
Returns:
int

getType()

Get the type for this property.
Returns:
string

setData(data)

Set the data for this property.
Parameters:
data - The data to set for this property.
           (type=string, int, or float)

Warning: See object.setProperty(). Changing data which is of a different type then the property is set to (i.e. setting an int value to a float type' property) will change the type of the property automatically.

setName(name)

Set the name of this property.
Parameters:
name - The new name of the property
           (type=string)

setPIDeflection(status)

Set the the Object's Particle Interaction Deflection Setting. 0 = Off, 1 = on
Parameters:
status - the new status
           (type=int)
Returns:
PyNone

setPIFalloff(falloff)

Set the the Object's Particle Interaction falloff. Values between 0 to 10.0
Parameters:
falloff - the Object's Particle Interaction New falloff.
           (type=float)
Returns:
PyNone

setPIMaxDist(MaxDist)

Set the the Object's Particle Interaction MaxDist. Values between 0 to 1000.0
Parameters:
MaxDist - the Object's Particle Interaction New MaxDist.
           (type=float)
Returns:
PyNone

setPIPerm(perm)

Set the the Object's Particle Interaction Permiability. Values between 0 to 10.0
Parameters:
perm - the Object's Particle Interaction New Permiability.
           (type=float)
Returns:
PyNone

setPIRandomDamp(damp)

Set the the Object's Particle Interaction RandomDamp. Values between 0 to 10.0
Parameters:
damp - the Object's Particle Interaction New RandomDamp.
           (type=float)
Returns:
PyNone

setPIStrength(strength)

Set the the Object's Particle Interaction Strength. Values between -1000.0 to 1000.0
Parameters:
strength - the Object's Particle Interaction New Strength.
           (type=float)
Returns:
PyNone

setPISurfaceDamp(damp)

Set the the Object's Particle Interaction SurfaceDamp. Values between 0 to 10.0
Parameters:
damp - the Object's Particle Interaction New SurfaceDamp.
           (type=float)
Returns:
PyNone

setPIType(type)

Set the the Object's Particle Interaction type. Use Module Constants
  • NONE
  • WIND
  • FORCE
  • VORTEX
  • MAGNET
Parameters:
type - the Object's Particle Interaction Type.
           (type=int)
Returns:
PyNone

setPIUseMaxDist(status)

Set the the Object's Particle Interaction MaxDist. 0 = Off, 1 = on
Parameters:
status - the new status
           (type=int)
Returns:
PyNone

setSBDefaultGoal(goal)

Set the the Object's SB DefaultGoal. Values between 0 to 1.0
Parameters:
goal - the Object's SB New DefaultGoal.
           (type=float)
Returns:
PyNone

setSBEnable(switch)

Enable / Disable Softbodies. 1: on 0: off
Parameters:
switch - the Object's SB New Enable Value.
           (type=int)
Returns:
PyNone

setSBErrorLimit(err)

Set the the Object's SB ErrorLimit. Values between 0 to 1.0
Parameters:
err - the Object's SB New ErrorLimit.
           (type=float)
Returns:
PyNone

setSBFriction(frict)

Set the the Object's SB Friction. Values between 0 to 10.0
Parameters:
frict - the Object's SB New Friction.
           (type=float)
Returns:
PyNone

setSBGoalFriction(gf)

Set the the Object's SB GoalFriction. Values between 0 to 10.0
Parameters:
gf - the Object's SB New GoalFriction.
           (type=float)
Returns:
PyNone

setSBGoalSpring(gs)

Set the the Object's SB GoalSpring. Values between 0 to 0.999
Parameters:
gs - the Object's SB New GoalSpring.
           (type=float)
Returns:
PyNone

setSBGravity(grav)

Set the the Object's SB Gravity. Values between 0 to 10.0
Parameters:
grav - the Object's SB New Gravity.
           (type=float)
Returns:
PyNone

setSBInnerSpring(sprr)

Set the the Object's SB InnerSpring. Values between 0 to 0.999
Parameters:
sprr - the Object's SB New InnerSpring.
           (type=float)
Returns:
PyNone

setSBInnerSpringFriction(sprf)

Set the the Object's SB InnerSpringFriction. Values between 0 to 10.0
Parameters:
sprf - the Object's SB New InnerSpringFriction.
           (type=float)
Returns:
PyNone

setSBMass(mass)

Set the the Object's SB Mass. Values between 0 to 50.0
Parameters:
mass - the Object's SB New mass.
           (type=float)
Returns:
PyNone

setSBMaxGoal(mg)

Set the the Object's SB MaxGoal. Values between 0 to 1.0
Parameters:
mg - the Object's SB New MaxGoal.
           (type=float)
Returns:
PyNone

setSBMinGoal(mg)

Set the the Object's SB MinGoal. Values between 0 to 1.0
Parameters:
mg - the Object's SB New MinGoal.
           (type=float)
Returns:
PyNone

setSBPostDef(switch)

Enable / Disable Softbodies PostDef option 1: on 0: off
Parameters:
switch - the Object's SB New PostDef Value.
           (type=int)
Returns:
PyNone

setSBStiffQuads(switch)

Enable / Disable Softbodies StiffQuads option 1: on 0: off
Parameters:
switch - the Object's SB New StiffQuads Value.
           (type=int)
Returns:
PyNone

setSBUseEdges(switch)

Enable / Disable Softbodies UseEdges option 1: on 0: off
Parameters:
switch - the Object's SB New UseEdges Value.
           (type=int)
Returns:
PyNone

setSBUseGoal(switch)

Enable / Disable Softbodies UseGoal option 1: on 0: off
Parameters:
switch - the Object's SB New UseGoal Value.
           (type=int)
Returns:
PyNone

Class Variable Details

data

Data for this property. Depends on property type.

name

The property name.

type

The property type.

   Home       Trees       Index       Help   

Blender

Generated by Epydoc 2.1 on Mon Jun 13 15:31:22 2005 http://epydoc.sf.net