Home | Hierarchy | Members | Alphabetical | Related Pages |
#include <inlineloadcontrol.h>
Inherits Node.
Public Member Functions | |
InlineLoadControl (const char *name="") | |
virtual | ~InlineLoadControl () |
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. | |
SFBool | load |
MFString | url |
Fields | |
A property or attribute of a node. Each node type has a fixed set of fields. Fields may contain various kinds of data and one or many values. Each field has a default value. | |
SFVec3f | bboxCenter |
SFVec3f | bboxSize |
Events In | |
EventIn< SFBool > | set_load |
EventIn< MFString > | set_url |
Events Out | |
EventOut< MFNode > | children |
EventOut< SFBool > | load_changed |
EventOut< MFString > | url_changed |
The InlineLoadControl node is a grouping node that reads its children data from a location in the World Wide Web. When its children are read and displayed is defined by the value of the load field.
If the load field is set to TRUE (the default value), the VRML world specified by the url field is loaded immediately. If the load field is set to FALSE, no action is taken. This node provides improved scalability over the Inline node which does not define when the world to which the url field is pointed should be loaded.
If the load field is set to FALSE, it is possible to explicitly load the URL at a later point by sending a TRUE event to the set_load eventIn of the node (e.g., via a ProximitySensor or other sensor). Similarly, if a FALSE event is sent to set_load, any currently loaded world will be unloaded from the scene graph.
The set_url eventIn can be used to change the world that is inlined by the InlineLoadControl node. If this value is set while a world is already loaded, that world will be unloaded and the new world that is pointed to by the new URL will be inlined.
The children eventOut is used to expose the scene graph hierarchy for the loaded VRML world. This is useful if the new nodes are to be inspected using an external interface or script. This functionality is not available using the base VRML Inline node.
The user is able to specify a bounding box for the InlineLoadControl node using the bboxCenter and bboxSize fields. This is a hint to the browser and could be used for optimization purposes such as culling.
InlineLoadControl | ( | const char * | name = "" |
) |
Construct a node with all its fields set to default value, which is equivalent to the code below:
load = true; bboxCenter.setXYZ(0,0,0); bboxSize.setXYZ(-1,-1,-1);
~InlineLoadControl | ( | ) | [virtual] |
Virtual destructor, does nothing
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:
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:
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:
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:
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:
Implements Node.
const char * typeName | ( | ) | const [inline, virtual] |
Returns "InlineLoadControl"
. 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.
See Detailed Description for meaning of this field. Default value is set to
load = true;
See Detailed Description for meaning of this field. Default value is set to MFString default value
See Detailed Description for meaning of this field. Default value is set to
bboxCenter.setXYZ(0,0,0);
See Detailed Description for meaning of this field. Default value is set to
bboxSize.setXYZ(-1,-1,-1);
See Detailed Description for meaning of this event.
Changed event associated to exposedField load
Changed event associated to exposedField url
Generated on 5 Jan 2007 with
![]() |
|