Houdini Engine 3.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Time

Functions

HAPI_DECL HAPI_GetTime (const HAPI_Session *session, float *time)
 Gets the global time of the scene. All API calls deal with this time to cook. More...
 
HAPI_DECL HAPI_SetTime (const HAPI_Session *session, float time)
 Sets the global time of the scene. All API calls will deal with this time to cook. More...
 
HAPI_DECL HAPI_GetUseHoudiniTime (const HAPI_Session *session, HAPI_Bool *enabled)
 Returns whether the Houdini session will use the current time in Houdini when cooking and retrieving data. By default this is disabled and the Houdini session uses time 0 (i.e. frame 1). In SessionSync, it is enabled by default, but can be overridden. Note that this function will ALWAYS return HAPI_RESULT_SUCCESS. More...
 
HAPI_DECL HAPI_SetUseHoudiniTime (const HAPI_Session *session, HAPI_Bool enabled)
 Sets whether the Houdini session should use the current time in Houdini when cooking and retrieving data. By default this is disabled and the Houdini session uses time 0 (i.e. frame 1). In SessionSync, it is enabled by default, but can be overridden. Note that this function will ALWAYS return HAPI_RESULT_SUCCESS. More...
 
HAPI_DECL HAPI_GetTimelineOptions (const HAPI_Session *session, HAPI_TimelineOptions *timeline_options)
 Gets the current global timeline options. More...
 
HAPI_DECL HAPI_SetTimelineOptions (const HAPI_Session *session, const HAPI_TimelineOptions *timeline_options)
 Sets the global timeline options. More...
 
HAPI_DECL HAPI_ResetSimulation (const HAPI_Session *session, HAPI_NodeId node_id)
 Resets the simulation cache of the asset. This is very useful for assets that use dynamics, to be called after some setup has changed for the asset - for example, asset inputs. More...
 

Detailed Description

Time related functions

Function Documentation

HAPI_DECL HAPI_GetTime ( const HAPI_Session session,
float *  time 
)

Gets the global time of the scene. All API calls deal with this time to cook.

Parameters
[in]sessionThe session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]timeTime as a float in seconds.
HAPI_DECL HAPI_GetTimelineOptions ( const HAPI_Session session,
HAPI_TimelineOptions timeline_options 
)

Gets the current global timeline options.

Parameters
[in]sessionThe session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]timeline_optionsThe global timeline options struct.
HAPI_DECL HAPI_GetUseHoudiniTime ( const HAPI_Session session,
HAPI_Bool enabled 
)

Returns whether the Houdini session will use the current time in Houdini when cooking and retrieving data. By default this is disabled and the Houdini session uses time 0 (i.e. frame 1). In SessionSync, it is enabled by default, but can be overridden. Note that this function will ALWAYS return HAPI_RESULT_SUCCESS.

Parameters
[in]sessionThe session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]enabledWhether use Houdini time is enabled or not.
HAPI_DECL HAPI_ResetSimulation ( const HAPI_Session session,
HAPI_NodeId  node_id 
)

Resets the simulation cache of the asset. This is very useful for assets that use dynamics, to be called after some setup has changed for the asset - for example, asset inputs.

Parameters
[in]sessionThe session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]node_idThe asset node id.
HAPI_DECL HAPI_SetTime ( const HAPI_Session session,
float  time 
)

Sets the global time of the scene. All API calls will deal with this time to cook.

Parameters
[in]sessionThe session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]timeTime as a float in seconds.
HAPI_DECL HAPI_SetTimelineOptions ( const HAPI_Session session,
const HAPI_TimelineOptions timeline_options 
)

Sets the global timeline options.

Parameters
[in]sessionThe session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]timeline_optionsThe global timeline options struct.
HAPI_DECL HAPI_SetUseHoudiniTime ( const HAPI_Session session,
HAPI_Bool  enabled 
)

Sets whether the Houdini session should use the current time in Houdini when cooking and retrieving data. By default this is disabled and the Houdini session uses time 0 (i.e. frame 1). In SessionSync, it is enabled by default, but can be overridden. Note that this function will ALWAYS return HAPI_RESULT_SUCCESS.

Parameters
[in]sessionThe session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]enabledSet to true to use Houdini time.