The AutoFile class is used to automatically reload files when modified. More...

#include <AutoFile.h>

Inherits SoFile.

Public Member Functions
	AutoFile (void)

virtual void	search (SoSearchAction *action)

virtual void	doAction (SoAction *action)

Public Member Functions inherited from SoFile
virtual SoType	getTypeId (void) const

	SoFile (void)

virtual void	callback (SoCallbackAction *action)

virtual void	GLRender (SoGLRenderAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *action)

virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

virtual void	audioRender (SoAudioRenderAction *action)

SoGroup *	copyChildren (void) const

virtual SoChildList *	getChildren (void) const

virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)

const SbString &	getFullName (void) const

Public Member Functions inherited from SoNode
void	setOverride (const SbBool state)

SbBool	isOverride (void) const

void	setNodeType (const NodeType type)

NodeType	getNodeType (void) const

virtual SoNode *	copy (SbBool copyconnections=FALSE) const

virtual SbBool	affectsState (void) const

virtual void	GLRenderBelowPath (SoGLRenderAction *action)

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	write (SoWriteAction *action)

virtual void	grabEventsSetup (void)

virtual void	grabEventsCleanup (void)

virtual void	startNotify (void)

SbUniqueId	getNodeId (void) const

virtual void	writeInstance (SoOutput *out)

virtual SoNode *	addToCopyDict (void) const

virtual SoFieldContainer *	copyThroughConnection (void) const

Public Member Functions inherited from SoFieldContainer
void	setToDefaults (void)

SbBool	hasDefaultValues (void) const

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	set (const char *const fielddata)

void	get (SbString &fielddata)

virtual int	getFields (SoFieldList &l) const

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getField (const SbName &name) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

SbBool	enableNotify (const SbBool flag)

SbBool	isNotifyEnabled (void) const

SbBool	set (const char fielddata, SoInput input)

void	get (SbString &fielddata, SoOutput *out)

virtual SbBool	validateNewFieldValue (SoField field, void newval)

virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

SbBool	getIsBuiltIn (void) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

void	setUserData (void *userdata) const

void *	getUserData (void) const

Public Member Functions inherited from SoBase
void	ref (void) const

void	unref (void) const

void	unrefNoDelete (void) const

int32_t	getRefCount (void) const

void	touch (void)

SbBool	isOfType (SoType type) const

virtual SbName	getName (void) const

virtual void	setName (const SbName &newname)

void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

const SoAuditorList &	getAuditors (void) const

SbBool	shouldWrite (void)

void	assertAlive (void) const

Static Public Member Functions
static void	initClass (void)

Static Public Member Functions inherited from SoFile
static void	setSearchOK (SbBool dosearch)

static SbBool	getSearchOK ()

Static Public Member Functions inherited from SoNode
static uint32_t	getCompatibilityTypes (const SoType &nodetype)

static SoNode *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoNodeList &l)

static void	initClasses (void)

static SbUniqueId	getNextNodeId (void)

static int	getActionMethodIndex (const SoType type)

static void	getBoundingBoxS (SoAction action, SoNode node)

static void	GLRenderS (SoAction action, SoNode node)

static void	callbackS (SoAction action, SoNode node)

static void	getMatrixS (SoAction action, SoNode node)

static void	handleEventS (SoAction action, SoNode node)

static void	pickS (SoAction action, SoNode node)

static void	rayPickS (SoAction action, SoNode node)

static void	searchS (SoAction action, SoNode node)

static void	writeS (SoAction action, SoNode node)

static void	audioRenderS (SoAction action, SoNode node)

static void	getPrimitiveCountS (SoAction action, SoNode node)

Static Public Member Functions inherited from SoFieldContainer
static void	initCopyDict (void)

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static void	copyDone (void)

Static Public Member Functions inherited from SoBase
static void	initClass (void)

static SoType	getClassTypeId (void)

static void	addName (SoBase const base, const char const name)

static void	removeName (SoBase const base, const char const name)

static void	incrementCurrentWriteCounter (void)

static void	decrementCurrentWriteCounter (void)

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

static SbBool	getTraceRefs (void)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static SbBool	readRoute (SoInput *input)

Public Attributes
SoSFFloat	interval

SoSFFloat	delay

SoSFInt32	priority

SoSFBool	active

Public Attributes inherited from SoFile
SoSFString	name

Public Attributes inherited from SoNode
	INVENTOR

	VRML1

	VRML2

	INVENTOR_1

	INVENTOR_2_0

	INVENTOR_2_1

	INVENTOR_2_5

	INVENTOR_2_6

	COIN_1_0

	COIN_2_0

	EXTENSION

Protected Member Functions
virtual	~AutoFile ()

virtual void	notify (SoNotList *list)

virtual SbBool	readNamedFile (SoInput *in)

Protected Member Functions inherited from SoFile
virtual const SoFieldData *	getFieldData (void) const

virtual	~SoFile ()

virtual SbBool	readInstance (SoInput *in, unsigned short flags)

Protected Member Functions inherited from SoNode
	SoNode (void)

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	SoBase (void)

virtual	~SoBase ()

virtual void	destroy (void)

SbBool	hasMultipleWriteRefs (void) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName (void) const

Additional Inherited Members
Public Types inherited from SoNode
enum	NodeType

Protected Types inherited from SoBase
enum	BaseFlags

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)

static void	setNextActionMethodIndex (int index)

static int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

Protected Attributes inherited from SoNode
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId

static int	nextActionMethodIndex

Detailed Description

The AutoFile class is used to automatically reload files when modified.

It works by using a timer sensor that triggers an idle sensor at regular intervals. The idle sensor then checks if the loaded file has been modified, and triggers a new timer sensor that reloads the file after a given delay. A delay is needed to avoid trying to load the file while it is being written by another process.

Constructor & Destructor Documentation

◆ AutoFile()

AutoFile::AutoFile ( void )

Constructor.

◆ ~AutoFile()

AutoFile::~AutoFile ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ doAction()

void AutoFile::doAction ( SoAction * action )

virtual

Reimplemented from SoFile.

◆ initClass()

void AutoFile::initClass ( void )

static

◆ notify()

void AutoFile::notify ( SoNotList * list )

protectedvirtual

Reimplemented from SoNode.

◆ readNamedFile()

SbBool AutoFile::readNamedFile ( SoInput * in )

protectedvirtual

Reimplemented from SoFile.

◆ search()

void AutoFile::search ( SoSearchAction * action )

virtual

Reimplemented from SoFile.

Member Data Documentation

◆ active

SoSFBool AutoFile::active

Sets whether autoload is active.

◆ delay

SoSFFloat AutoFile::delay

Sets the delay before file is reloaded after a modification is detected.

◆ interval

SoSFFloat AutoFile::interval

Sets how often the idle sensor is triggered.

◆ priority

SoSFInt32 AutoFile::priority

Sets the priority of the idle sensor. It is set to the default priority (100) by default.

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

C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/AutoFile.h
C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/AutoFile.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AutoFile()

◆ ~AutoFile()

Member Function Documentation

◆ doAction()

◆ initClass()

◆ notify()

◆ readNamedFile()

◆ search()

Member Data Documentation

◆ active

◆ delay

◆ interval

◆ priority