UnrealCV

Tutorials

  • Getting started
    • Download a game binary
    • UnrealCV commands
      • Try UnrealCV commands
    • Use python client to execute commands
      • Install UnrealCV python library
      • Generate some images from the scene
      • Next: Use UnrealCV in the game mode or plugin mode?
      • Tutorials
      • Articles
  • Generate Images
    • Connect to the game
    • Load a camera trajectory
    • Render an image
    • Ground truth generation
    • Get object information
    • Show info of an object
    • Clean up resources
  • Integration with an AI program
    • Run the demo

UE4 Plugin

  • Install UnrealCV Plugin
    • Use compiled plugin binary
    • Install from UE4 marketplace (coming)
    • Compile from source code
    • Special tips for Linux
  • Usage in the Editor
    • Edit Object Specularity
    • Edit Object Color
  • Development
    • Create a C++ game project
    • Compile the C++ project
    • Add a new command
  • The configuration file
    • Change game resolution
    • Change the server port
  • Package a new game
    • Guide to submit a binary
      • 1. Modify an UE4 config file
      • 2. Package your game project
      • 3. Make a pull request
    • Packaging binaries automatically

Reference

  • The architecture of UnrealCV
    • Project Layout
  • Command System
    • Command cheatsheet
    • 1. Camera operation
    • 2. Object interaction
    • 3. Plugin commands
    • 4. Action commands
    • Run UE4 built-in commands
    • Run Blueprint commands
  • Model Zoo
    • RealisticRendering
    • ArchinteriorsVol2Scene1
    • ArchinteriorsVol2Scene2
    • ArchinteriorsVol2Scene3
    • UrbanCity
    • First Person Shooter
  • Trouble Shooting
    • Supported Unreal Engine Version
      • Client
      • 4.14
      • Verified projects
    • Known issues
    • Build
      • Mac
    • Issues and workarounds
  • API
    • Python
    • MATLAB
    • Core
    • Basic
    • API
  • CHANGELOG
    • Development branch
    • v0.3.0 - Stability improvement
    • v0.2.0 - First public release
  • Contribute
    • Bug Reporting
    • Requesting A New Feature
    • Pull Request
  • Contact
    • Team Members
  • UE4 Resources
    • 3D Resources (models, scenes)
    • C++ Development
UnrealCV
  • Docs »
  • Index
  • Edit on GitHub

Index

A | B | C | F | R | S | U

A

  • AUE4CVCharacter (C++ class)
  • AUE4CVGameMode (C++ class)
  • AUE4CVPawn (C++ class)

B

  • BaseClient (class in unrealcv)

C

  • Client (class in unrealcv)
  • connect() (unrealcv.BaseClient method)

F

  • FActionCommandHandler (C++ class)
  • FAliasCommandHandler (C++ class)
  • FAsyncWatcher (C++ class)
  • FCameraCommandHandler (C++ class)
  • FCommandDispatcher (C++ class), [1]
  • FCommandHandler (C++ class)
  • FExecStatus (C++ class)
  • FObjectCommandHandler (C++ class)
  • FPluginCommandHandler (C++ class)
  • FPromise (C++ class)
  • FServerConfig (C++ class)
  • FUE4CVServer (C++ class)
  • FUE4CVServer::CommandDispatcher (C++ member)
  • FUE4CVServer::Config (C++ member)
  • FUE4CVServer::Get (C++ function)
  • FUE4CVServer::GetGameWorld (C++ function)
  • FUE4CVServer::GetPawn (C++ function)
  • FUE4CVServer::InitWorld (C++ function)
  • FUE4CVServer::NetworkManager (C++ member)
  • FUE4CVServer::RegisterCommandHandlers (C++ function)
  • FUE4CVServer::SendClientMessage (C++ function)
  • FUE4CVServer::Tick (C++ function)

R

  • request() (unrealcv.Client method)

S

  • send() (unrealcv.BaseClient method)

U

  • unrealcv (module)

© Copyright 2017, UnrealCV team. Revision e83f6e7e.

Built with Sphinx using a theme provided by Read the Docs.