XdkWrl: TextureTransform Class Reference

Home | Hierarchy | Members | Alphabetical | Related Pages

# TextureTransform Class Reference
[Standard Node Types]

`#include <texturetransform.h>`

Inherits Node.

List of all members.

## Public Member Functions
| TextureTransform (const char *name="")
virtual | ~TextureTransform ()
virtual unsigned int | nbFields () const
virtual FieldHandle | field (const std::string &n)
virtual FieldHandle | field (unsigned int i)
virtual bool | isSetToDefaultValue (unsigned int i) const
virtual unsigned int | nbEventsIn () const
virtual EventInHandle | eventIn (const std::string &n)
virtual EventInHandle | eventIn (unsigned int i)
virtual unsigned int | nbEventsOut () const
virtual EventOutHandle | eventOut (const std::string &n)
virtual EventOutHandle | eventOut (unsigned int i)
const char * | typeName () const
virtual Node * | duplicate () const
virtual Node * | duplicate (std::map< const Node *, Node * > &) const
## Public Attributes
Exposed Fields
A field that is capable of receiving events via an eventIn to change its value(s), and generating events via an eventOut when its value(s) change.
SFVec2f | center
SFFloat | rotation
SFVec2f | scale
SFVec2f | translation
Events In
EventIn< SFVec2f > | set_center
EventIn< SFFloat > | set_rotation
EventIn< SFVec2f > | set_scale
EventIn< SFVec2f > | set_translation
Events Out
EventOut< SFVec2f > | center_changed
EventOut< SFFloat > | rotation_changed
EventOut< SFVec2f > | scale_changed
EventOut< SFVec2f > | translation_changed

## Detailed Description

Here is the documentation for this node type, from the ISO standard.

## 6.68 TextureTransform

The TextureTransform node defines a 2D transformation that is applied to texture coordinates (see 6.48, TextureCoordinate). This node affects the way textures coordinates are applied to the geometric surface. The transformation consists of (in order):

1. a translation;
2. a rotation about the centre point;
3. a non-uniform scale about the centre point.

These parameters support changes to the size, orientation, and position of textures on shapes. Note that these operations appear reversed when viewed on the surface of geometry. For example, a scale value of (2 2) will scale the texture coordinates and have the net effect of shrinking the texture size by a factor of 2 (texture coordinates are twice as large and thus cause the texture to repeat). A translation of (0.5 0.0) translates the texture coordinates +.5 units along the S-axis and has the net effect of translating the texture -0.5 along the S-axis on the geometry's surface. A rotation of /2 of the texture coordinates results in a -/2 rotation of the texture on the geometry.

The center field specifies a translation offset in texture coordinate space about which the rotation and scale fields are applied. The scale field specifies a scaling factor in S and T of the texture coordinates about the center point. scale values shall be in the range (-, ). The rotation field specifies a rotation in radians of the texture coordinates about the center point after the scale has been applied. A positive rotation value makes the texture coordinates rotate counterclockwise about the centre, thereby rotating the appearance of the texture itself clockwise. The translation field specifies a translation of the texture coordinates.

In matrix transformation notation, where Tc is the untransformed texture coordinate, Tc' is the transformed texture coordinate, C (center), T (translation), R (rotation), and S (scale) are the intermediate transformation matrices,

        Tc' = -C ื S ื R ื C ื T ื Tc

Note that this transformation order is the reverse of the Transform node transformation order since the texture coordinates, not the texture, are being transformed (i.e., the texture coordinate system).

## Constructor & Destructor Documentation

TextureTransform | ( | const char * | name = `""` | ) |

Construct a node with all its fields set to default value, which is equivalent to the code below:

      center.setXY(0,0);
      rotation = 0.0f;
      scale.setXY(1,1);
      translation.setXY(0,0);

~TextureTransform | ( |  | ) | `[virtual]`

Virtual destructor, does nothing

## Member Function Documentation

unsigned int nbFields | ( |  | ) | const`[inline, virtual]`

Returns the number of fields (exposed or not) for this node type.

Implements Node.

wrl::Node::FieldHandle field | ( | const std::string & | n | ) | `[virtual]`

Return a handle on the field named `n` of the node or a "unknown" typed handle if there is no such field. Valid names are:

- center
- rotation
- scale
- translation

Implements Node.

wrl::Node::FieldHandle field | ( | unsigned int | n | ) | `[virtual]`

Return a handle on the `i` th field of the node or a "unknown" typed handle if there is no such node. Here is how `i` is related to fields:

- 0 : center
- 1 : rotation
- 2 : scale
- 3 : translation This function is useful, with nbFields() if you want to traverse all fields of a Node.

Implements Node.

bool isSetToDefaultValue | ( | unsigned int | i | ) | const`[virtual]`

Implements Node.

unsigned int nbEventsIn | ( |  | ) | const`[inline, virtual]`

Returns the number of events in for this node type.

Implements Node.

wrl::Node::EventInHandle eventIn | ( | const std::string & | n | ) | `[virtual]`

Return a handle on the event in named `n` of the node or a "unknown" typed handle if there is no such event. Valid names are:

- set_center
- set_rotation
- set_scale
- set_translation

Implements Node.

wrl::Node::EventInHandle eventIn | ( | unsigned int | n | ) | `[virtual]`

Return a handle on the `i` th event in of the node or a "unknown" typed handle if there is no such node. emarks This class has no eventIn. This function is useful, with nbEventsIn() if you want to traverse all events in of a Node.

Implements Node.

unsigned int nbEventsOut | ( |  | ) | const`[inline, virtual]`

Returns the number of events out for this node type.

Implements Node.

wrl::Node::EventOutHandle eventOut | ( | const std::string & | n | ) | `[virtual]`

Return a handle on the event out named `n` of the node or a "unknown" typed handle if there is no such event. Valid names are:

- center_changed
- rotation_changed
- scale_changed
- translation_changed

Implements Node.

wrl::Node::EventOutHandle eventOut | ( | unsigned int | n | ) | `[virtual]`

Return a handle on the `i` th event out of the node or a "unknown" typed handle if there is no such node. Here is how `i` is related to fields:

- 0 : center_changed
- 1 : rotation_changed
- 2 : scale_changed
- 3 : translation_changed This function is useful, with nbEventsOut() if you want to traverse all events in of a Node.

Implements Node.

const char * typeName | ( |  | ) | const`[inline, virtual]`

Returns `"TextureTransform"`. Useful for printing.

Implements Node.

wrl::Node * duplicate | ( |  | ) | const`[virtual]`

Returns a deep copy of this node, that is a fully independant node with all children (if any) also copied. This is mainly useful for instanciating protos.

Implements Node.

virtual Node* duplicate | ( | std::map< const Node *, Node * > & |  | ) | const`[virtual]`

Implements Node.

## Member Data Documentation

SFVec2f center

See Detailed Description for meaning of this field. Default value is set to

           center.setXY(0,0);

SFFloat rotation

See Detailed Description for meaning of this field. Default value is set to

           rotation = 0.0f;

SFVec2f scale

See Detailed Description for meaning of this field. Default value is set to

           scale.setXY(1,1);

SFVec2f translation

See Detailed Description for meaning of this field. Default value is set to

           translation.setXY(0,0);

EventIn<SFVec2f> set_center

Set event associated to exposedField center

EventIn<SFFloat> set_rotation

Set event associated to exposedField rotation

EventIn<SFVec2f> set_scale

Set event associated to exposedField scale

EventIn<SFVec2f> set_translation

Set event associated to exposedField translation

EventOut<SFVec2f> center_changed

Changed event associated to exposedField center

EventOut<SFFloat> rotation_changed

Changed event associated to exposedField rotation

EventOut<SFVec2f> scale_changed

Changed event associated to exposedField scale

EventOut<SFVec2f> translation_changed

Changed event associated to exposedField translation

Generated on 5 Jan 2007 with version 1.5.1. |