Noise Modeler Library  0.1
Library for procedurally generating noise-based terrains and other content
 All Classes Files Functions Variables Enumerations Enumerator Groups Pages
nm::OutputLink Class Reference

an output of a Module More...

#include <outputlink.hpp>

Inheritance diagram for nm::OutputLink:
nm::UserDataProvider

Public Member Functions

 OutputLink (Module &owner, const ModuleOutput &type)
 OutputLink. More...
 
bool addLink (InputLink &input)
 Add a connection from this OutputLink to the specified InputLink. More...
 
bool unlink (InputLink *input)
 Remove the link an InputLink if it exists. More...
 
void unlinkAll ()
 Remove links to all inputs. More...
 
unsigned int numLinks ()
 
InputLinkgetLink (unsigned int index)
 
const ModulegetOwner () const
 
ModulegetOwner ()
 
const ModuleOutputgetModuleOutput () const
 
- Public Member Functions inherited from nm::UserDataProvider
void * getUserData () const
 
void setUserData (void *userData)
 

Public Attributes

signal< void(OutputLink &)> linksChanged
 
signal< void(OutputLink &)> destroying
 

Detailed Description

an output of a Module

OutputLinks are created by the library itself when instantiation a new Module

Constructor & Destructor Documentation

nm::OutputLink::OutputLink ( Module owner,
const ModuleOutput type 
)
inlineexplicit

OutputLink.

Parameters
ownerwhich module this is an output of
typewhich ModuleOutput this is an outputLink for

Member Function Documentation

bool nm::OutputLink::addLink ( InputLink input)

Add a connection from this OutputLink to the specified InputLink.

Parameters
input
Returns
Whether a new link was added.
bool nm::OutputLink::unlink ( InputLink input)

Remove the link an InputLink if it exists.

Parameters
input
Returns
Whether a link was removed
void nm::OutputLink::unlinkAll ( )

Remove links to all inputs.

This also removes the links from the inputs to the output


The documentation for this class was generated from the following files: