Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoSFRotation Class Reference

Field containing a rotation. More...

#include <Inventor/fields/SoSFRotation.h>

+ Inheritance diagram for SoSFRotation:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
const SoSFRotationoperator= (const SoSFRotation &f)
 Copy from another field of same type.
 
 SoSFRotation ()
 Default constructor.
 
virtual ~SoSFRotation ()
 Destructor.
 
const SbRotationgetValue () const
 Returns this field's value.
 
void setValue (const SbRotation &newValue)
 Sets this field to newValue.
 
const SbRotationoperator= (const SbRotation &newValue)
 Sets this field to newValue.
 
int operator== (const SoSFRotation &f) const
 Returns TRUE if otherField is of the same type and has the same value as this field.
 
int operator!= (const SoSFRotation &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 getValue (SbVec3f &axis, float &angle) const
 Gets the value of the field as an axis/angle.
 
void setValue (float q0, float q1, float q2, float q3)
 Sets the field to the given quaternion (x, y, z, w).
 
void setValue (const float q[4])
 Sets the field to the given quaternion (x, y, z, w).
 
void setValue (const SbVec3f &axis, float angle)
 Sets the field to the rotation given by axis/angle.
 
void setValue (const SbRotationd &rotd)
 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 rotation.

A field containing a single SbRotation (an arbitrary rotation).

SoSFRotations are written to file as four floating point values separated by whitespace. The 4 values represent an axis of rotation followed by the amount of right-handed rotation about that axis, in radians. For example, a 180 degree rotation about the Y axis is:

   0 1 0 3.14159265

NOTE: When you specify an SoSFRotation value using setValue with 4 floating point values, those values will be interpreted as a quaternion (x, y, z, w) rather than an axis and a rotation. To specify an SoSFRotation value using an axis and a rotation, you must use the following method: setValue(const SbVec3f &axis, float angle).

SEE ALSO

SbRotation, SoField, SoSField, SoMFRotation

Definition at line 93 of file SoSFRotation.h.

Constructor & Destructor Documentation

◆ SoSFRotation()

SoSFRotation::SoSFRotation ( )

Default constructor.

◆ ~SoSFRotation()

virtual SoSFRotation::~SoSFRotation ( )
virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoSFRotation::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoSFRotation::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ getValue() [1/2]

const SbRotation & SoSFRotation::getValue ( ) const
inline

Returns this field's value.

Definition at line 95 of file SoSFRotation.h.

◆ getValue() [2/2]

void SoSFRotation::getValue ( SbVec3f axis,
float &  angle 
) const
inline

Gets the value of the field as an axis/angle.

Definition at line 106 of file SoSFRotation.h.

◆ getValueSize()

virtual size_t SoSFRotation::getValueSize ( ) const
inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 95 of file SoSFRotation.h.

◆ operator!=()

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

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

Definition at line 95 of file SoSFRotation.h.

◆ operator=() [1/2]

const SbRotation & SoSFRotation::operator= ( const SbRotation newValue)
inline

Sets this field to newValue.

Definition at line 95 of file SoSFRotation.h.

◆ operator=() [2/2]

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

Copy from another field of same type.

◆ operator==()

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

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

◆ setValue() [1/5]

void SoSFRotation::setValue ( const float  q[4])

Sets the field to the given quaternion (x, y, z, w).

◆ setValue() [2/5]

void SoSFRotation::setValue ( const SbRotation newValue)

Sets this field to newValue.

◆ setValue() [3/5]

void SoSFRotation::setValue ( const SbRotationd rotd)

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() [4/5]

void SoSFRotation::setValue ( const SbVec3f axis,
float  angle 
)

Sets the field to the rotation given by axis/angle.

◆ setValue() [5/5]

void SoSFRotation::setValue ( float  q0,
float  q1,
float  q2,
float  q3 
)

Sets the field to the given quaternion (x, y, z, w).


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