Path¶

This class describes a structural path, i.e. a trajectory of structural particles (smason.Modeling.StructuralModel.Particle).

You can add, insert, and remove conformation and parts of a path from a path using samson.Modeling.StructuralModel.Path.add(), samson.Modeling.StructuralModel.Path.insert(), and samson.Modeling.StructuralModel.Path.remove() functions respectively.

You can also add, insert, and remove structural particles from a conformation using samson.Modeling.StructuralModel.Path.addStructuralParticle(), samson.Modeling.StructuralModel.Path.insertStructuralParticle(), and samson.Modeling.StructuralModel.Path.removeStructuralParticle() functions respectively.

You can also get and set position, velocity, and force data for all structural particles in a path or for a particular structural particle.

You can get a node indexer of structural particles in the conformation:

# get all paths in the active document
pathIndexer = SAMSON.getNodes('node.type path')

# get the first conformation
path = pathIndexer[0]

# get an indexer of structural particles in the path
structuralParticleIndexer = path.getStructuralParticleIndexer()

You can create a conformation from a path for a particular step:

# create a conformation from the first step in the path
conformationIndexer = path.createConformation(0)
conformation = conformationIndexer[0]
# name the conformation
conformation.name = "Initial state"

# turn the undo system on
SAMSON.beginHolding("Add new conformation")
# hold the cloned folder instance
SAMSON.hold(conformation)

# create the cloned folder
conformation.create()

# add the conformation to the active document
SAMSON.getActiveDocument().addChild(conformation)

# turn the undo system off
SAMSON.endHolding()

You can set the current step in a path:

# set the current step of the path to 10
path.currentStep = 10

You can go through a path to visualize it in SAMSON’s viewport as follows:

# set the step duration in seconds
path.stepDuration = Quantity.second(0.05)

# go through all the steps in the path
for step in range(path.numberOfSteps):
        path.currentStep = step
        # request SAMSON to process events
        SAMSON.processEvents()