All Classes
| Class | Description |
|---|---|
| Action |
This class is the entry point for processing operations.
|
| ActionDurations |
Mock durations for different Actions.
|
| ActionExecution |
Performs the Action and maintenance around the Action such as
- Setting the start time and saving the operation's duration
- Executing pauses before and after the operation
- Determining the success of the operation
- Saving the MatchSnapshots
Any Action that is run independently of this class should
have code to perform maintenance around the Action.
|
| ActionInterface |
Actions that are run from the Action class need to follow this interface.
|
| ActionOptions |
ActionOptions provides options for configuring an action.
|
| ActionOptions.Action |
BasicActions:
FIND
CLICK
DEFINE return a Region with specific x,y,w,h
TYPE sends keyboard input
MOVE moves the mouse
VANISH is successful when an Image or State disappears
GET_TEXT reads text from a Region
HIGHLIGHT highlights a Match, Region, or Location
SCROLL_MOUSE_WHEEL
MOUSE_DOWN
MOUSE_UP
KEY_DOWN
KEY_UP
CompositeActions:
CLICK_UNTIL clicks Matches, Regions, and/or Locations until a condition is fulfilled
DRAG
|
| ActionOptions.Builder | |
| ActionOptions.ClickUntil |
Specifies the condition to fulfill after a Click.
|
| ActionOptions.DefineAs |
Anchors define Locations in Matches and specify how these Locations should be used
to define a Region (see the Anchor class for more info).
|
| ActionOptions.DoOnEach |
Images can contain multiple Patterns.
|
| ActionOptions.Find |
Keep in mind:
ObjectCollections can contain multiple Images.
|
| ActionOptions.GetTextUntil |
TEXT_APPEARS: Keep searching for text until some text appears.
|
| ActionOptions.ScrollDirection |
For scrolling with the mouse wheel
|
| ActionOptionsForDrag | |
| ActionOptionsObjectCollectionPair | |
| ActionResultCombo |
An ActionResultsCombos has both an action and an expected result.
|
| ActionService |
Returns the corresponding Action class as specified in ActionOptions.
|
| AddNonImageObjects |
Non-image objects are adjusted and added directly to the Matches variable.
|
| AdjustMatches |
Adjust Matches according to the options in ActionOptions.
|
| AfterClick |
After a successful click,
Sets the probability that the object remains visible or disappears.
|
| Anchor |
Anchors define
1) A Position in the Image Match or Region
2) A Position in the Region to define
A point defined with Position #1 is used to define part of a Region.
|
| Anchors | |
| ANSI | |
| App |
Gets the window of the App in focus.
|
| BasicAction |
BasicActions, which run for 1 iteration, require 1 or no Find operations.
|
| BrobotSettings |
Global settings
Some Brobot settings override Sikuli settings.
|
| Click |
Clicks on an Image Match, Region, or Location.
|
| ClickLocationOnce |
Wrapper class for Click, handles real and mock clicks.
|
| ClickType |
Converts ClickType to a Sikuli Button.
|
| ClickType.Type | |
| ClickUntil |
ClickUntil clicks Matches until a condition occurs or the operation times out.
|
| CommonActionOptions | |
| CommonActions |
It is useful to create one or more CommonActions classes for your applications
in order to reduce code redundancy and make your code more readable.
|
| CommonARClickCombos |
Currently ActionResultCombos are set up for click operations as the first action.
|
| CommonARTypeCombos | |
| CommonDrag |
This class defines some typical configurations for Drag and
allows for multiple drag operations.
|
| CommonMultipleActions |
This is an example of a more complex custom action.
|
| CommonResults | |
| CommonSelect | |
| CommonTransitions |
This class should make it simpler to create common StateTransitions.
|
| CompositeAction |
CompositeActions are built from BasicActions.
|
| CopyActionOptions |
This class creates a deep copy of most of the fields in ActionOptions.
|
| DanglingSnapshots |
DanglingSnapshots keep Snapshots with their objects while the operation is in progress.
|
| DefinedBorders |
Each region has 4 borders that can be defined: top, bottom, left, right.
|
| DefineHelper |
Helper functions for various Define classes
|
| DefineInsideAnchors |
Defines a Region as the smallest rectangle produced by Matches and Locations.
|
| DefineOutsideAnchors |
Defines a Region as the largest rectangle produced by Matches and Locations.
|
| DefineRegion |
Defines a Region with the Define method specified in the ActionOptions.
|
| DefineWithMatch |
Defines a Region around a Match.
|
| DefineWithWindow |
Defines a Region using the active Window as a reference.
|
| Direction | |
| DoTransition |
Completes a whole Transition (FromTransition and ToTransition),
including all States to activate and exit.
|
| DoUntilActionObject |
The DoUntilActionObject contains both ActionOptions and ObjectCollections for both
'do' and 'until' Actions.
|
| DoUntilActionObject.Builder | |
| Drag |
Drags from an Image Match, Region, or Location to an Image Match, Region, or Location
Drag is a Composite Action composed of a Basic Action (Find) and a Sikuli Wrapper (Drag Location)
|
| DragLocation |
Wrapper class for Drag, handles real and mock drags.
|
| ExitSequences |
Defines the condition necessary to stop repeating sequences for individual Actions.
|
| Find |
All find requests come here first and are then sent to a specific type of find method.
|
| FindAllPatterns |
Finds all Matches for all Patterns in the Brobot Image.
|
| FindFirstPattern |
Returns Matches for the first Pattern found in a Brobot Image.
|
| FindFunctions |
Retrieve a Find function with its Find type.
|
| FindImage |
Implements the Find.FIRST and Find.ALL methods for Images.
|
| FindImageObject | |
| FindImageOrRIP |
Sends the Image object to either FindImage or FindRIP depending on whether the Image location can vary.
|
| FindPattern |
Contains functions to find one or all Matches given an Image and a Region.
|
| FindPatternInterface | |
| FindRIP |
RegionImagePairs are pairs of (Region, Image)
The Region in a RegionImagePairs is defined once an Image is found.
|
| FindWrapperMethods |
Returns the class corresponding to the selected Find option.
|
| GetDragLocation |
Returns the 'from' and 'to' Locations to be used in Drag.
|
| GetText |
GetText retrieves text from a Region.
|
| GetTextWrapper |
Wrapper class for GetText, handles real and mock text queries.
|
| Highlight |
Highlight all Matches at once, or one at a time.
|
| HighlightMatch |
Wrapper class for Highlight, performs real or mock highlights.
|
| Image |
Images can hold multiple Patterns.
|
| ImageInfo |
Helper functions for working with Images.
|
| ImagePatterns |
Functions for working with Image Patterns
|
| ImageUtils | |
| InitialStates |
Given sets of possible active States, this class searches for these States
to set active States.
|
| KeyDown |
Uses only ObjectCollection #1
An ObjectCollection can have multiple keys
ActionObjects hold special keys such as CTRL that are pressed first
|
| KeyDownWrapper |
NOT WORKING AS EXPECTED
Wrapper class for KeyDown, holds a Key down as a real or mock action.
|
| KeyUp |
Uses only ObjectCollection #1
An ObjectCollection can have multiple keys
ActionObjects hold special keys such as CTRL that are released last
|
| KeyUpWrapper |
Wrapper class for KeyUp, works for real or mocked operations.
|
| Location |
Location can be an absolute position (x,y) on the screen,
or a relative position (%w, %h) of a Region.
|
| Matches |
The results object for all actions.
|
| MatchHistory |
Used for mock runs when not empty; otherwise, the State's probability variable is used.
|
| MatchMaker |
Creates Match objects when probability is being used instead of Snapshots.
|
| MatchMaker.Builder | |
| MatchObject |
MatchObject is used to store information about new Image matches.
|
| MatchSnapshot |
MatchSnapshots record a match (or failed match) and the search options at a single point in time.
|
| MatchSnapshot.Builder | |
| Mock |
The Action methods should be unaware of the mock process, which should occur only
at the interface between Brobot and Sikuli, where the Wrapper classes live.
|
| MockFind |
Mock Matches can be found with 1 of 2 methods:
History: Using the MatchSnapshots associated with individual Images.
|
| MockStateManagement |
Takes care of setting probabilities for States and State objects
|
| MockStatus |
Keeps track of the number of mocks performed.
|
| MockText |
Mock text for GetText Actions using the probability method (and not Snapshots).
|
| MouseDown |
Presses and holds a mouse button.
|
| MouseDownWrapper |
Wrapper class for MouseDown, works for real or mock actions.
|
| MouseUp |
Releases a mouse button.
|
| MouseUpWrapper |
Wrapper class for MouseUp, works for real or mocked actions.
|
| MouseWheel |
Wrapper class for MouseWheel, works for real or mocked actions.
|
| MoveMouse |
Moves the mouse to one or more locations.
|
| MoveMouseWrapper |
Wrapper class for MoveMouse, works for real or mocked actions.
|
| MultipleActions | |
| MultipleActionsObject | |
| MultipleBasicActions |
Helper function for Composite Actions
|
| MultipleDrags |
NOT WORKING!
|
| MultipleMoves |
This is an example of how to create an Action using the MultipleActions class.
|
| NullState |
NullState is used as a generic State for passing simple objects
(non State objects) to Actions.
|
| NullState.Enum | |
| ObjectCollection |
This class holds all the objects that can be passed to an Action.
|
| ObjectCollection.Builder | |
| Output | |
| Pair<U,V> | |
| ParameterCollection | |
| ParameterCollections |
ParameterCollections help Brobot calibrate specific parameters with respect
to success conditions.
|
| ParameterThresholds | |
| Path |
A single path from a start State to a target State.
|
| PathFinder |
Finds all paths from a set of start States to a target State.
|
| PathManager |
If a Path is unsuccessfully traversed, we find ourselves somewhere in the middle of
the Path.
|
| Paths |
A list of Path objects comprising the possible ways to go from
start States to the target State.
|
| Position |
Position is defined by (%w, %h) and can be used to get a location in a Region.
|
| Position.Name | |
| Region |
Region extends the Sikuli class Region and adds, among other functionality, new
initializers, analysis tools, and points x2 and y2.
|
| RegionImagePair |
An Image with an associated Region.
|
| RegionImagePairs |
RegionImagePairs contain Images that should appear in fixed locations.
|
| RegionOps |
Analysis functions involving Regions
|
| Report |
Prints to the console if the output meets the required reporting level.
|
| Report.OutputLevel | |
| RunARCombo |
Returns a List with the first element the Action Matches and the second element the Results Matches
ActionResultsCombos are typically:
- an Action such as CLICK
- a Result from an operation such as FIND
The parameters and results only get recorded if the Action is successful.
|
| ScrollMouseWheel |
Scrolls the mouse wheel up or down.
|
| SearchRegions |
SearchRegions allows for multiple Regions to be associated with an Image.
|
| Select |
Select is a custom Action built using the custom SelectActionObject.
|
| SelectActionObject | |
| SelectActionObject.Builder | |
| SetHiddenStates |
Set the hidden States after a successful State transition.
|
| State |
States give a Brobot application structure.
|
| State.Builder | |
| StateEnum | |
| StateFinder |
This class finds the active States after Brobot is lost.
|
| StateImageObject |
StateImageObject represents an Image that exists in the owner State.
|
| StateImageObject.Builder | |
| StateLocation |
A StateLocation belongs to a State and usually has a Location that
has a special meaning for its owner State.
|
| StateLocation.Builder | |
| StateMemory |
StateMemory keeps track of which States are currently active.
|
| StateMemory.Enum | |
| StateObject |
The MatchHistory keep a record of the StateObject's Snapshots.
|
| StateRegion |
A StateRegion belongs to a State and usually has a Region that
has a special meaning for its owner State.
|
| StateRegion.Builder | |
| States | |
| StateService |
Manages the State repository.
|
| StateString |
A State String belongs to a State and usually has a String that
has a special meaning for the owner State.
|
| StateString.Builder | |
| StateString.InNullState | |
| StateText |
StateText is text that always appears in its owner State.
|
| StateText.Builder | |
| StateTransition |
After a successful transition (both 'from' and 'to' Transitions):
'activate' holds all States to make active
'exit' holds all States to deactivate
|
| StateTransition.Builder | |
| StateTransition.StaysVisible | |
| StateTransitions |
StateTransitions hold all the Transitions for a State.
|
| StateTransitions.Builder | |
| StateTransitionsJointTable |
Holds all static incoming and outgoing Transitions,
plus the variable transitions to hidden States.
|
| StateTransitionsManagement |
We want to go to a specific State, the target State.
|
| StateTransitionsRepository |
Manages the StateTransitions repository and retrieves
StateTransitions given a StateEnum.
|
| StateTransitionsService |
Finds the correct Transition from one State to another,
taking into account the hidden States.
|
| StringSimilarity |
Calculates the similarity of 2 Strings.
|
| Success |
Defines the success condition for individual Actions.
|
| TestOutput |
Tests can be used for mocks or for live execution.
|
| Text |
Text read from the screen is a stochastic variable.
|
| TextSelector |
The TextSelector returns text from the stochastic Text variable (Strings are stored in a List),
which it believes has the highest probability of being the actual text on the screen.
|
| TextSelector.Method | |
| Time |
Deals with Action durations, both real and mock.
|
| TimeWrapper |
Wraps the Time functions to allow for mocking actions.
|
| TransitionFetcher |
This class returns an object containing the StateTransitions objects and StateTransition objects that
we are interested in for a specific transition from one State to another.
|
| TraversePaths |
Moves through the Paths to reach the target State.
|
| Tree |
Aims to visualize the State hierarchy.
|
| TypeText |
Types text to the window in focus.
|
| TypeTextWrapper |
Wrapper class for TypeText, works with real or mocked actions.
|
| UnknownState |
The Unknown State is usually the start point for any application,
and can also be found when Brobot has become lost.
|
| UnknownState.Enum | |
| UseDefinedRegion | |
| Wait |
Wrapper class for Wait, works with real or mocked actions.
|
| WaitVanish |
Returns a successful Matches object if at some point no objects are found.
|