rs3.properties.material.stageFactors.StageFactors module

class rs3.properties.material.stageFactors.StageFactors.StageFactorsBase(client: Client, id: str)

Bases: _ProxyObject, IPropertyGroupAccessors

getApplyConstitutiveModelStageFactors() → bool

setApplyConstitutiveModelStageFactors(value: bool)

getApplyHydraulicStageFactors() → bool

setApplyHydraulicStageFactors(value: bool)

getResetElementStressOnMaterialChange() → bool

setResetElementStressOnMaterialChange(value: bool)

getProperties()

Retrieve properties as a dictionary.

setProperties(ApplyConstitutiveModelStageFactors: bool = None, ApplyHydraulicStageFactors: bool = None, ResetElementStressOnMaterialChange: bool = None)

Set properties using keyword arguments.

class rs3.properties.material.stageFactors.StageFactors.DefinedStageFactor(id: str, stageFactorID: str, client: Client)

Bases: IStageFactorBase

class rs3.properties.material.stageFactors.StageFactors.StageFactor(id: str, stageFactorID: str, client: Client)

Bases: DefinedStageFactor

class rs3.properties.material.stageFactors.StageFactors.StageFactors(client: Client, id: str)

Bases: StageFactorsBase, AbsoluteStageFactorInterface[DefinedStageFactor, StageFactor]

Examples

See Material Stage Factors Script Examples.

createStageFactor(stage: int) → DefinedStageFactor

Creates a stage factor for the given stage.

NOTE: Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.

setDefinedStageFactors(stageFactors: dict[int, StageFactor])

Sets the defined stage factors to those given.

NOTE: Invalidates any existing stage factor proxies. Get them again using getDefinedStageFactors or getStageFactor.