Simulation Construction Set

Simulation Construction Set

  • IHMC Home
  • All IHMC Docs
  • About IHMC

›Robot and Joint API

SCS API

  • Summary
  • Constructors
  • Simulation Parameters
  • Create the World
  • Simulate methods
  • Data Import Export Methods
  • Camera Methods
  • Adding to the GUI

Link and LinkGraphicsDescription API

  • Summary
  • Link constructor and methods
  • LinkGraphicsDescription constructor and methods
  • Adding shapes
  • YoAppearance helper API

Robot and Joint API

  • Summary
  • Robot
  • Robot Constructor and Methods
  • Joint Constructor and methods
  • General Joint Methods

Kinematic, ExternalForce, and GroundContactPoint API

  • Summary
  • Introduction to special points
  • ExternalForcePoint and GroundContactPoint constructors and methods
  • GroundContactModel interface
  • GroundProfile Interface

Robot Constructor and Methods

Table 5 contains the constructors and methods for the class Robot. To create a Robot you first call its constructor with its name, then create a tree of joints, and then set the root joint of that tree using Robot.addRootJoint(Joint root). You may add multiple root joints using addRootJoint, if your Robot is comprised of several independent trees of Joints. If the robot has a control system or ground contact points, you set the controller using setController and set the GroundContactModel using setGroundContactModel. To change the value of a variable in your robot, use setVariable. To extract a YoVariable from the robot, use getVar() with the name of the variable.

Creates a new robot.

Robot(String name)

Adds a root joint for this robot.

void addRootJoint(Joint root)

Sets gravity for this robot. Default is (0.0, 0.0, -9.81).

void setGravity(double gX, double gY, double gZ)
public void setGravity(double gZ) 

Sets the RobotController for this robot.

void setController(RobotController c)

Sets the GroundContactModel for this robot.

void setGroundContactModel(GroundContactModel)

Returns the ground contact points associated with this robot. They will be stored in an ArrayList, which is a Java utility class in (java.util.ArrayList)

ArrayList getGroundContactPoints()

Gets or sets the variable with the given name.

YoVariable getVar(String name)
void setVariable(String name, double val)

Adds a static Link with no physics, or a static Java3D BranchGroup. For creating the surrounding static world graphics.

void addStaticLink(Link staticLink) 
void addStaticBranchGroup(BranchGroup staticBranchGroup)
← RobotJoint Constructor and methods →
Simulation Construction Set
Docs
Quick StartSoftware Documentation
Community
GitHubFacebookTwitterYouTube
Copyright © 2018 IHMC Robotics