RAParticleAssemblyPart
Last update: 23.02.2026class RAParticleAssemblyPart
Rocky PrePost Scripting wrapper for a single entry in a single Particle Assembly’s part list.
Access this wrapper from a given RAParticleAssembly with:
assembly_parts = particle_assembly.GetAssemblyParts()
assembly_part_1 = assembly_parts.New()
assembly_part_1.SetParticle('Particle 1')
assembly_part_1.SetPositionX(0.75, 'm')
Methods:
| Name | Description |
|---|---|
GetAngle([unit]) |
Get the value of "Angle". |
GetAvailableParticles() |
Get all available Particles. |
GetParticle() |
Get the "Particle". |
GetPositionX([unit]) |
Get the value of "Position X". |
GetPositionY([unit]) |
Get the value of "Position Y". |
GetPositionZ([unit]) |
Get the value of "Position Z". |
GetRotationX([unit]) |
Get the value of "Rotation X". |
GetRotationY([unit]) |
Get the value of "Rotation Y". |
GetRotationZ([unit]) |
Get the value of "Rotation Z". |
GetScale([unit]) |
Get the value of "Scale". |
SetAngle(value[, unit]) |
Set the value of "Angle". |
SetParticle(value) |
Set the "Particle". |
SetPositionX(value[, unit]) |
Set the value of "Position X". |
SetPositionY(value[, unit]) |
Set the value of "Position Y". |
SetPositionZ(value[, unit]) |
Set the value of "Position Z". |
SetRotationX(value[, unit]) |
Set the value of "Rotation X". |
SetRotationY(value[, unit]) |
Set the value of "Rotation Y". |
SetRotationZ(value[, unit]) |
Set the value of "Rotation Z". |
SetScale(value[, unit]) |
Set the value of "Scale". |
GetAngle(unit: str | None = None)
Get the value of “Angle”.
- Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “dega”.
GetAvailableParticles()
Get all available Particles.
- Return type:
List[
RAParticle] A list ofRAParticle.
GetParticle()
Get the “Particle”.
- Return type:
RAParticle
GetPositionX(unit: str | None = None)
Get the value of “Position X”.
- Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.
GetPositionY(unit: str | None = None)
Get the value of “Position Y”.
- Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.
GetPositionZ(unit: str | None = None)
Get the value of “Position Z”.
- Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.
GetRotationX(unit: str | None = None)
Get the value of “Rotation X”.
- Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.
GetRotationY(unit: str | None = None)
Get the value of “Rotation Y”.
- Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.
GetRotationZ(unit: str | None = None)
Get the value of “Rotation Z”.
- Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.
GetScale(unit: str | None = None)
Get the value of “Scale”.
- Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.
SetAngle(value: str | float, unit: str | None = None)
Set the value of “Angle”.
- Parameters:
- value – The value to set. This value can be an expression with input variables or float type.
- unit – The unit for value. If no unit is provided, value is assumed to be in “dega”.
SetParticle(value)
Set the “Particle”.
:param unicode, RAParticle value:
: Either the API object wrapping the desired entity or its name.
SetPositionX(value: str | float, unit: str | None = None)
Set the value of “Position X”.
- Parameters:
- value – The value to set. This value can be an expression with input variables or float type.
- unit – The unit for value. If no unit is provided, value is assumed to be in “m”.
SetPositionY(value: str | float, unit: str | None = None)
Set the value of “Position Y”.
- Parameters:
- value – The value to set. This value can be an expression with input variables or float type.
- unit – The unit for value. If no unit is provided, value is assumed to be in “m”.
SetPositionZ(value: str | float, unit: str | None = None)
Set the value of “Position Z”.
- Parameters:
- value – The value to set. This value can be an expression with input variables or float type.
- unit – The unit for value. If no unit is provided, value is assumed to be in “m”.
SetRotationX(value: str | float, unit: str | None = None)
Set the value of “Rotation X”.
- Parameters:
- value – The value to set. This value can be an expression with input variables or float type.
- unit – The unit for value. If no unit is provided, value is assumed to be in “m”.
SetRotationY(value: str | float, unit: str | None = None)
Set the value of “Rotation Y”.
- Parameters:
- value – The value to set. This value can be an expression with input variables or float type.
- unit – The unit for value. If no unit is provided, value is assumed to be in “m”.
SetRotationZ(value: str | float, unit: str | None = None)
Set the value of “Rotation Z”.
- Parameters:
- value – The value to set. This value can be an expression with input variables or float type.
- unit – The unit for value. If no unit is provided, value is assumed to be in “m”.
SetScale(value: str | float, unit: str | None = None)
Set the value of “Scale”.
- Parameters:
- value – The value to set. This value can be an expression with input variables or float type.
- unit – The unit for value. If no unit is provided, value is assumed to be in “-“.