GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOGATE (3)

NAME

SoGate — selectively copies its input to its output

CONTENTS

Inherits From
Synopsis
Description
Inputs
Outputs
Methods
File Format/defaults
See Also

INHERITS FROM

SoBase > SoFieldContainer > SoEngine > SoGate

SYNOPSIS

#include <Inventor/engines/SoGate.h>

Inputs from class SoGate:

    SoSFBool    
                    
SoSFBool             enable    
SoSFTrigger    
                    
SoSFTrigger          trigger    
<inputType>    
                    
<inputType>          input

Outputs from class SoGate:

    (<outputType>)    
                    
(<outputType>)       output

Methods from class SoGate:

       
                    
                     SoGate(SoType inputType)

Methods from class SoEngine:

    static SoType    
                    
static SoType        getClassTypeId()    
virtual int    
                    
virtual int          getOutputs(SoEngineOutputList &list) const    
SoEngineOutput *    
                    
SoEngineOutput *     getOutput(const SbName &outputName) const    
SbBool    
                    
SbBool               getOutputName(const SoEngineOutput *output, SbName &outputName) const    
SoEngine *    
                    
SoEngine *           copy() const    
static SoEngine *    
                    
static SoEngine *    getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoEngineList &list)

Methods from class SoFieldContainer:

    void    
                    
void                 setToDefaults()    
SbBool    
                    
SbBool               hasDefaultValues() const    
SbBool    
                    
SbBool               fieldsAreEqual(const SoFieldContainer *fc) const    
void    
                    
void                 copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)    
SbBool    
                    
SbBool               set(const char *fieldDataString)    
void    
                    
void                 get(SbString &fieldDataString)    
virtual int    
                    
virtual int          getFields(SoFieldList &resultList) const    
virtual SoField *    
                    
virtual SoField *    getField(const SbName &fieldName) const    
SbBool    
                    
SbBool               getFieldName(const SoField *field, SbName &fieldName) const    
SbBool    
                    
SbBool               isNotifyEnabled() const    
SbBool    
                    
SbBool               enableNotify(SbBool flag)

Methods from class SoBase:

    void    
                    
void                 ref()    
void    
                    
void                 unref() const    
void    
                    
void                 unrefNoDelete() const    
void    
                    
void                 touch()    
virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
virtual void    
                    
virtual void         setName(const SbName &name)    
virtual SbName    
                    
virtual SbName       getName() const

DESCRIPTION

This engine selectively copies its input to its output. The type of the input field can be any subclass of SoMField. The type is specified when an instance of the class is created. For example, SoGate(SoMFFloat::getClassTypeId()) creates an engine that copies floating-point values.

The enable input controls continous flow-through of values. While enable is TRUE, the input will be copied to the output. Alternatively, by touching the trigger input, you can copy a single value from the input to the output.

Note that unlike most other engine fields, input and output are pointers. Note also that by default input does not contain any values.

INPUTS

    SoSFBool    
                    
SoSFBool             enable
Enable continous flow-through.

    SoSFTrigger    
                    
SoSFTrigger          trigger
Copy a single value.

    <inputType>    
                    
<inputType>          input
The value that is copied to the output when the gate is open.

OUTPUTS

    (<outputType>)    
                    
(<outputType>)       output
Contains a copy of the input value if the gate is open.

METHODS

       
                    
                     SoGate(SoType inputType)
Constructor. The argument specifies the type of the input field.

FILE FORMAT/DEFAULTS

Gate {



type     <inputType>
input    []
enable   FALSE
trigger  


}

SEE ALSO

SoEngineOutput, SoConcatenate, SoSelectOne

Search for    or go to Top of page |  Section 3 |  Main Index


SOGATE(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.