Class: Tracksperanto::Tool::Base

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
BlockInit, Casts, ConstName, Parameters, SimpleExport
Defined in:
lib/tools/base.rb

Overview

The base tool class works just like a Tracksperanto::Export::Base, but it only wraps another exporting object and does not get registered on it’s own as an export format. Tool can be used to massage the tracks being exported in various interesting ways - like moving the coordinates, clipping the keyframes, scaling the whole export or even reversing the trackers to go backwards

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Parameters

#parameter, #parameters

Methods included from SimpleExport

#just_export

Methods included from ConstName

#const_name

Methods included from Casts

#cast_to_bool, #cast_to_float, #cast_to_int, #cast_to_string

Constructor Details

#initialize(*exporter_and_args_for_block_init) ⇒ Base

Constructor accepts the exporter that will be wrapped, followed by the optional options hash and the optional block that yields self



31
32
33
34
 
# File 'lib/tools/base.rb', line 31

def initialize(*exporter_and_args_for_block_init)
  @exporter = exporter_and_args_for_block_init.shift
  super
end

Class Method Details

.action_description ⇒ Object

Returns the human name of the action that the tool will perform. The action is the in infinitive form, like “Remove all the invalid keyframes”, “Crop the image” and so on



25
26
27
 
# File 'lib/tools/base.rb', line 25

def self.action_description
  "Base tool class"
end

.inherited(by) ⇒ Object

Used to automatically register your tool in Tracksperanto.tools Normally you wouldn’t need to override this



18
19
20
21
 
# File 'lib/tools/base.rb', line 18

def self.inherited(by)
  Tracksperanto.tools.push(by)
  super
end