Open Inventor Release 2023.2.2
 
Loading...
Searching...
No Matches
SoSFVec2f Class Reference

Field containing a two-dimensional vector. More...

#include <Inventor/fields/SoSFVec2f.h>

+ Inheritance diagram for SoSFVec2f:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
const SoSFVec2foperator= (const SoSFVec2f &f)
 Copy from another field of same type.
 
 SoSFVec2f ()
 Default constructor.
 
virtual ~SoSFVec2f ()
 Destructor.
 
const SbVec2fgetValue () const
 Returns this field's value.
 
void setValue (const SbVec2f &newValue)
 Sets this field to newValue.
 
const SbVec2foperator= (const SbVec2f &newValue)
 Sets this field to newValue.
 
int operator== (const SoSFVec2f &f) const
 Returns TRUE if otherField is of the same type and has the same value as this field.
 
int operator!= (const SoSFVec2f &f) const
 Returns FALSE if otherField is of the same type and has the same value as this field.
 
virtual size_t getValueSize () const
 Get size of the value.
 
void setValue (float x, float y)
 Sets the field to the given value.
 
void setValue (const float xy[2])
 Sets the field to the given value.
 
void setValue (const SbVec2d &vec2d)
 Convenience method that allows you to specify a field value using a double precision variable.
 
- Public Member Functions inherited from SoField
void setIgnored (SbBool ig)
 Sets the ignore flag for this field.
 
SbBool isIgnored () const
 Gets the ignore flag for this field.
 
SbBool isDefault () const
 Gets the state of default flag of the field.
 
void enableConnection (SbBool flag)
 Field connections may be enabled and disabled.
 
SbBool isConnectionEnabled () const
 Returns FALSE if connections to this field are disabled.
 
SbBool connectFrom (SoEngineOutput *engineOutput)
 Connects this field from an engine output.
 
SbBool connectFrom (SoField *field)
 Connects this field to another field.
 
SbBool connectFrom (SoVRMLInterpOutput *interpOutput)
 Connects this field from an interpOutput.
 
SbBool appendConnection (SoEngineOutput *engineOutput)
 Appends this field to the list of connections from another engineOutput.
 
SbBool appendConnection (SoField *field)
 Appends this field to the list of connections from another field.
 
SbBool appendConnection (SoVRMLInterpOutput *interpOutput)
 Appends this field to the list of connections from another interpOutput.
 
void disconnect (SoEngineOutput *engineOutput)
 Disconnect the field from the requested engineOutput.
 
void disconnect (SoField *field)
 Disconnect the field from the requested field.
 
void disconnect (SoVRMLInterpOutput *interpOutput)
 Disconnect the field from the requested interpOutput.
 
int getNumConnections () const
 Returns the number of connections to this field.
 
int getConnections (SoFieldList &list)
 Returns a list of the connections to this field.
 
void disconnect ()
 Disconnect the field from whatever it was connected to.
 
SbBool isConnected () const
 Returns TRUE if the field is connected to anything.
 
SbBool isConnectedFromVRMLInterp () const
 Returns TRUE if the field is connected to a VRML interpOutput.
 
SbBool isConnectedFromEngine () const
 Returns TRUE if the field is connected to an engine's output.
 
SbBool isConnectedFromField () const
 Returns TRUE if the field is connected to another field.
 
SbBool getConnectedEngine (SoEngineOutput *&engineOutput) const
 Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.
 
SbBool getConnectedField (SoField *&writingField) const
 Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.
 
SbBool getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
 Returns the VRMLInterpolator output field is connected to.
 
int getForwardConnections (SoFieldList &list) const
 Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.
 
SoFieldContainergetContainer () const
 Returns the object that contains this field.
 
SoNONUNICODE SbBool set (const char *valueString)
 Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
 
SbBool set (const SbString &valueString)
 Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
 
void get (SbString &valueString)
 Returns the value of the field in the Open Inventor file format, even if the field has its default value.
 
virtual void touch ()
 Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.
 
int operator== (const SoField &f) const
 Return TRUE if this field is of the same type and has the same value as f.
 
int operator!= (const SoField &f) const
 Return FALSE if this field is of the same type and has the same value as f.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoSField
static SoType getClassTypeId ()
 Return the type identifier for this field class.
 
- Static Public Member Functions inherited from SoField
static SoType getClassTypeId ()
 Return the type identifier for this field class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Detailed Description

Field containing a two-dimensional vector.

SoSFVec2fs are written to file as a pair of floating point values separated by whitespace.

SEE ALSO

SoField, SoSField, SoMFVec2f

Definition at line 78 of file SoSFVec2f.h.

Constructor & Destructor Documentation

◆ SoSFVec2f()

SoSFVec2f::SoSFVec2f ( )

Default constructor.

◆ ~SoSFVec2f()

virtual SoSFVec2f::~SoSFVec2f ( )
virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoSFVec2f::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoSFVec2f::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ getValue()

const SbVec2f & SoSFVec2f::getValue ( ) const
inline

Returns this field's value.

Definition at line 80 of file SoSFVec2f.h.

◆ getValueSize()

virtual size_t SoSFVec2f::getValueSize ( ) const
inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 80 of file SoSFVec2f.h.

◆ operator!=()

int SoSFVec2f::operator!= ( const SoSFVec2f f) const
inline

Returns FALSE if otherField is of the same type and has the same value as this field.

Definition at line 80 of file SoSFVec2f.h.

◆ operator=() [1/2]

const SbVec2f & SoSFVec2f::operator= ( const SbVec2f newValue)
inline

Sets this field to newValue.

Definition at line 80 of file SoSFVec2f.h.

◆ operator=() [2/2]

const SoSFVec2f & SoSFVec2f::operator= ( const SoSFVec2f f)

Copy from another field of same type.

◆ operator==()

int SoSFVec2f::operator== ( const SoSFVec2f f) const

Returns TRUE if otherField is of the same type and has the same value as this field.

◆ setValue() [1/4]

void SoSFVec2f::setValue ( const float  xy[2])

Sets the field to the given value.

◆ setValue() [2/4]

void SoSFVec2f::setValue ( const SbVec2d vec2d)

Convenience method that allows you to specify a field value using a double precision variable.

Note that Open Inventor fields still store only single precision values, not double precision values. The specified value is converted to single precision, then stored.

◆ setValue() [3/4]

void SoSFVec2f::setValue ( const SbVec2f newValue)

Sets this field to newValue.

◆ setValue() [4/4]

void SoSFVec2f::setValue ( float  x,
float  y 
)

Sets the field to the given value.


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