TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Modules | Classes | Macros | Typedefs | Enumerations | Functions
Vlk

Detailed Description

Modules

 Vlk Utils
 

Classes

struct  iVlk
 Vlk interface. More...
 
struct  iVlkActionSink
 Vlk action sink. {DispatchWrapper}. More...
 
struct  iVlkAction
 Vlk action. More...
 
struct  iVlkCamera
 Vlk camera interface. More...
 
struct  iVlkEntitySink
 Entity sink interface. {DispatchWrapper}. More...
 
struct  iVlkEntity
 Entity interface. More...
 
struct  iVlkEventClass
 Vlk event class interface {DispatchWrapper}. More...
 
struct  iVlkLevelDesc
 Vlk level description interface. More...
 
struct  iVlkEntityClassDesc
 Vlk entity class description interface. More...
 
struct  iVlkActionDesc
 Vlk action description interface. More...
 
struct  iVlkEventClassDesc
 Vlk event description interface. More...
 
struct  iVlkGame
 Vlk game interface. More...
 
struct  iVlkLayer
 Vlk layer interface. More...
 
struct  iVlkLevel
 Vlk level interface. More...
 
struct  iVlkSelection
 Vlk selection interface. More...
 
struct  iVlkTimeline
 Timeline. More...
 
struct  iVlkUtils
 
struct  iResourceFile
 Resource file interface. {DispatchWrapper}. More...
 
struct  iResourceFileLoader
 Resource file loader interface. {DispatchWrapper}. More...
 
struct  iResources
 Resources interface. More...
 
struct  iVlkServices
 
struct  iVlkWidgetTimeBar
 Vlk widget time bar interface. More...
 
struct  iVlkWidgetTimeline
 Vlk widget timeline interface. More...
 

Macros

#define VLK_ENTITY_MSGID(TYPE, BYTE)
 

Typedefs

typedef ni::tU32 tVlkFingerIDFlags
 Vlk Finger ID flags type. More...
 
typedef ni::SinkList
< iVlkActionSink > 
tVlkActionSinkLst
 Vlk action sink list. More...
 
typedef ni::tU32 tVlkEntitySerializeFlags
 Entity serialize flags type. More...
 
typedef ni::tU32 tVlkEntityFlags
 Entity flags type. More...
 
typedef ni::tU32 tVlkEntityClassFlags
 Entity class flags type. More...
 
typedef ni::tInterfaceCVec
< iVlkEntity > 
tVlkEntityPtrCVec
 VlkEntity smart pointer vector. More...
 
typedef ni::tU32 tVlkLayerFlags
 Vlk layer flags type. More...
 
typedef ni::tU32 tVlkWidgetTimeBarSerializeFlags
 Vlk widget time bar flags type. More...
 
typedef ni::tU32 tVlkWidgetFilterDisplayFlags
 Vlk widget filter display flags type. More...
 

Enumerations

enum  eVlkPlaybackRenderMode {
  eVlkPlaybackRenderMode_Regular,
  eVlkPlaybackRenderMode_AR,
  eVlkPlaybackRenderMode_VR,
  eVlkPlaybackRenderMode_ForceDWORD
}
 Vlk playback mode. More...
 
enum  eVlkPlaybackOrientation {
  eVlkPlaybackOrientation_Landscape,
  eVlkPlaybackOrientation_Portrait,
  eVlkPlaybackOrientation_ForceDWORD
}
 Vlk orientation mode. More...
 
enum  eVlkState {
  eVlkState_Physics,
  eVlkState_Timelines,
  eVlkState_Animations,
  eVlkState_EditMode,
  eVlkState_EntityUpdateRate,
  eVlkState_ParticlesLod,
  eVlkState_PlaybackRenderMode,
  eVlkState_Last,
  eVlkState_ForceDWORD
}
 Vlk states. More...
 
enum  eVlkFingerIDFlags {
  eVlkFingerIDFlags_Touch0,
  eVlkFingerIDFlags_Touch1,
  eVlkFingerIDFlags_Touch2,
  eVlkFingerIDFlags_Touch3,
  eVlkFingerIDFlags_Touch4,
  eVlkFingerIDFlags_Touch5,
  eVlkFingerIDFlags_Touch6,
  eVlkFingerIDFlags_Touch7,
  eVlkFingerIDFlags_Touch8,
  eVlkFingerIDFlags_Touch9,
  eVlkFingerIDFlags_MouseLeft,
  eVlkFingerIDFlags_MouseRight,
  eVlkFingerIDFlags_MouseMiddle,
  eVlkFingerIDFlags_PointerLocked,
  eVlkFingerIDFlags_All
}
 Vlk Finger ID flags. More...
 
enum  eVlkEntityCameraType {
  eVlkEntityCameraType_Regular,
  eVlkEntityCameraType_AR,
  eVlkEntityCameraType_VR,
  eVlkEntityCameraType_ForceDWORD
}
 Vlk camera type. More...
 
enum  eVlkEntityMessageType {
  eVlkEntityMessageType_System,
  eVlkEntityMessageType_Edition,
  eVlkEntityMessageType_LifeTime,
  eVlkEntityMessageType_Serialize,
  eVlkEntityMessageType_Status,
  eVlkEntityMessageType_Layer,
  eVlkEntityMessageType_Update,
  eVlkEntityMessageType_Rendering,
  eVlkEntityMessageType_Physics,
  eVlkEntityMessageType_Input,
  eVlkEntityMessageType_Datatable,
  eVlkEntityMessageType_Action,
  eVlkEntityMessageType_Custom,
  eVlkEntityMessageType_ForceDWORD
}
 Vlk entity message type. More...
 
enum  eVlkEntityMessage {
  eVlkEntityMessage_SinkAttached,
  eVlkEntityMessage_SinkDetached,
  eVlkEntityMessage_ObserverNotify,
  eVlkEntityMessage_EnterEditMode,
  eVlkEntityMessage_LeaveEditMode,
  eVlkEntityMessage_Selected,
  eVlkEntityMessage_Unselected,
  eVlkEntityMessage_EditCommand,
  eVlkEntityMessage_ChildAttached,
  eVlkEntityMessage_ChildDetached,
  eVlkEntityMessage_SetParent,
  eVlkEntityMessage_TimelineAdded,
  eVlkEntityMessage_TimelineRemoved,
  eVlkEntityMessage_ActionAdded,
  eVlkEntityMessage_ActionRemoved,
  eVlkEntityMessage_MaterialAdded,
  eVlkEntityMessage_MaterialRemoved,
  eVlkEntityMessage_MaterialLibraryChanged,
  eVlkEntityMessage_Invalidate,
  eVlkEntityMessage_SetName,
  eVlkEntityMessage_SetGroup,
  eVlkEntityMessage_SetFlags,
  eVlkEntityMessage_SetEnabled,
  eVlkEntityMessage_Timer,
  eVlkEntityMessage_Update,
  eVlkEntityMessage_UpdateFrame,
  eVlkEntityMessage_RenderBase,
  eVlkEntityMessage_RenderTranslucent,
  eVlkEntityMessage_RenderOverlay,
  eVlkEntityMessage_RenderDebug,
  eVlkEntityMessage_Render2D,
  eVlkEntityMessage_RenderPostProcess,
  eVlkEntityMessage_RenderBackground,
  eVlkEntityMessage_RenderEditMode,
  eVlkEntityMessage_RenderSetup,
  eVlkEntityMessage_EnterCollision,
  eVlkEntityMessage_LeaveCollision,
  eVlkEntityMessage_EnterRayHit,
  eVlkEntityMessage_LeaveRayHit,
  eVlkEntityMessage_KeyDown,
  eVlkEntityMessage_KeyUp,
  eVlkEntityMessage_KeyChar,
  eVlkEntityMessage_FingerDown,
  eVlkEntityMessage_FingerUp,
  eVlkEntityMessage_FingerMove,
  eVlkEntityMessage_FingerRelativeMove,
  eVlkEntityMessage_GameCtrl,
  eVlkEntityMessage_GameCtrlButtonDown,
  eVlkEntityMessage_GameCtrlButtonUp,
  eVlkEntityMessage_Pinch,
  eVlkEntityMessage_SerializeBase,
  eVlkEntityMessage_SerializeEntity,
  eVlkEntityMessage_SerializeChildren,
  eVlkEntityMessage_SerializeTimeline,
  eVlkEntityMessage_SerializeMaterials,
  eVlkEntityMessage_SerializeFinalize,
  eVlkEntityMessage_PropertyChanged,
  eVlkEntityMessage_SetLayer,
  eVlkEntityMessage_SetLayerCollideScene,
  eVlkEntityMessage_SetLayerPainterDrawSet,
  eVlkEntityMessage_SetLayerVizCell,
  eVlkEntityMessage_SetLevel,
  eVlkEntityMessage_LevelLoaded,
  eVlkEntityMessage_ActionSucceeded,
  eVlkEntityMessage_ActionFailed,
  eVlkEntityMessage_PlaybackRoot,
  eVlkEntityMessage_PlaybackPlay,
  eVlkEntityMessage_PlaybackStop,
  eVlkEntityMessage_PlaybackPause,
  eVlkEntityMessage_PlaybackRenderMode,
  eVlkEntityMessage_PlaybackOrientation,
  eVlkEntityMessage_Custom0,
  eVlkEntityMessage_Custom1,
  eVlkEntityMessage_Custom2,
  eVlkEntityMessage_Custom3,
  eVlkEntityMessage_Custom4,
  eVlkEntityMessage_Custom5,
  eVlkEntityMessage_Custom6,
  eVlkEntityMessage_Custom7,
  eVlkEntityMessage_Entity0,
  eVlkEntityMessage_Entity1,
  eVlkEntityMessage_Entity2,
  eVlkEntityMessage_Entity3,
  eVlkEntityMessage_Entity4,
  eVlkEntityMessage_Entity5,
  eVlkEntityMessage_Entity6,
  eVlkEntityMessage_Entity7,
  eVlkEntityMessage_ForceDWORD
}
 Vlk entity message. More...
 
enum  eVlkEntityFlags {
  eVlkEntityFlags_Default,
  eVlkEntityFlags_Relative,
  eVlkEntityFlags_LocalTimeline,
  eVlkEntityFlags_LocalStatus,
  eVlkEntityFlags_ChildrenLocalStatus,
  eVlkEntityFlags_TransformFrozen,
  eVlkEntityFlags_DontSerialize,
  eVlkEntityFlags_Timer,
  eVlkEntityFlags_NotifyPropertyChanged,
  eVlkEntityFlags_BlackBox,
  eVlkEntityFlags_ForceDWORD
}
 Entity flags. More...
 
enum  eVlkEntityClassFlags {
  eVlkEntityClassFlags_Dummy,
  eVlkEntityClassFlags_Light,
  eVlkEntityClassFlags_Camera,
  eVlkEntityClassFlags_Layer,
  eVlkEntityClassFlags_Character,
  eVlkEntityClassFlags_Level,
  eVlkEntityClassFlags_NotifyPropertyChanged,
  eVlkEntityClassFlags_NoTranslate,
  eVlkEntityClassFlags_NoRotate,
  eVlkEntityClassFlags_NoScale,
  eVlkEntityClassFlags_UniformScale,
  eVlkEntityClassFlags_SelectedRenderEditMode,
  eVlkEntityClassFlags_InputTarget,
  eVlkEntityClassFlags_ForceDWORD
}
 Vlk entity class flags. More...
 
enum  eVlkEntitySerializeFlags {
  eVlkEntitySerializeFlags_Write,
  eVlkEntitySerializeFlags_Read,
  eVlkEntitySerializeFlags_Timeline,
  eVlkEntitySerializeFlags_Children,
  eVlkEntitySerializeFlags_NoRoot,
  eVlkEntitySerializeFlags_NoTableNameCheck,
  eVlkEntitySerializeFlags_Materials,
  eVlkEntitySerializeFlags_IsChild,
  eVlkEntitySerializeFlags_PropertyBox,
  eVlkEntitySerializeFlags_ForceDWORD
}
 Entity serialize flags. More...
 
enum  eVlkEntityPrimitiveType {
  eVlkEntityPrimitiveType_Box,
  eVlkEntityPrimitiveType_Sphere,
  eVlkEntityPrimitiveType_Cylinder,
  eVlkEntityPrimitiveType_PlaneVt,
  eVlkEntityPrimitiveType_PlaneHz,
  eVlkEntityPrimitiveType_ForceDWORD
}
 Standard primitive entity type. More...
 
enum  eVlkEntityTextAnchorH {
  eVlkEntityTextAnchorH_Center,
  eVlkEntityTextAnchorH_Left,
  eVlkEntityTextAnchorH_Right,
  eVlkEntityTextAnchorH_ForceDWORD
}
 Text entity horizontal anchor points. More...
 
enum  eVlkEntityTextAnchorV {
  eVlkEntityTextAnchorV_Center,
  eVlkEntityTextAnchorV_Top,
  eVlkEntityTextAnchorV_Bottom,
  eVlkEntityTextAnchorV_ForceDWORD
}
 Text entity vertical anchor points. More...
 
enum  eVlkFactoryMessage {
  eVlkFactoryMessage_Cached,
  eVlkFactoryMessage_Restored,
  eVlkFactoryMessage_SpawnEntity,
  eVlkFactoryMessage_SpawnEntityGrid,
  eVlkFactoryMessage_CacheEntity,
  eVlkFactoryMessage_CacheAllEntities
}
 
enum  eVlkLayerFlags {
  eVlkLayerFlags_None,
  eVlkLayerFlags_CollideScene,
  eVlkLayerFlags_PainterDrawSet,
  eVlkLayerFlags_DontPaintRenderTargets,
  eVlkLayerFlags_VizCell,
  eVlkLayerFlags_Camera,
  eVlkLayerFlags_ViewportStretch,
  eVlkLayerFlags_ViewportCenterH,
  eVlkLayerFlags_ViewportCenterV,
  eVlkLayerFlags_ViewportRight,
  eVlkLayerFlags_ViewportBottom,
  eVlkLayerFlags_DynamicsScene,
  eVlkLayerFlags_RenderTarget,
  eVlkLayerFlags_ForceDWORD
}
 Vlk layer type. More...
 
enum  eVlkPlayback {
  eVlkPlayback_Stopped,
  eVlkPlayback_Playing,
  eVlkPlayback_Paused,
  eVlkPlayback_ForceDWORD
}
 Timeline playback states. More...
 
enum  eVlkLicense {
  eVlkLicense_Free,
  eVlkLicense_Individual,
  eVlkLicense_Business,
  eVlkLicense_Enterprise,
  eVlkLicense_ErrorUnknown,
  eVlkLicense_ErrorNoDigest,
  eVlkLicense_ErrorNoSig,
  eVlkLicense_ErrorReadSig,
  eVlkLicense_ErrorVerify,
  eVlkLicense_ForceDWORD
}
 
enum  eVlkWidgetTimelineMessage {
  eVlkWidgetTimelineMessage_UpdateTreeContextMenu,
  eVlkWidgetTimelineMessage_UpdateToolbar,
  eVlkWidgetTimelineMessage_ForceDWORD
}
 Vlk widget timeline custom messages. More...
 
enum  eVlkWidgetTimelineCmd {
  eVlkWidgetTimelineCmd_FirstCmd,
  eVlkWidgetTimelineCmd_CmdPlay,
  eVlkWidgetTimelineCmd_CmdPause,
  eVlkWidgetTimelineCmd_CmdStop,
  eVlkWidgetTimelineCmd_CmdAddAction,
  eVlkWidgetTimelineCmd_CmdAddTimeline,
  eVlkWidgetTimelineCmd_CmdDeleteSelection,
  eVlkWidgetTimelineCmd_CmdReloadSelection,
  eVlkWidgetTimelineCmd_CmdSetEnabled,
  eVlkWidgetTimelineCmd_CmdExplore,
  eVlkWidgetTimelineCmd_CmdExploreUp,
  eVlkWidgetTimelineCmd_CmdAddTimelineEx,
  eVlkWidgetTimelineCmd_CmdAddEvent,
  eVlkWidgetTimelineCmd_CmdZoomIn,
  eVlkWidgetTimelineCmd_CmdZoomOut,
  eVlkWidgetTimelineCmd_CmdZoomDefault,
  eVlkWidgetTimelineCmd_ForceDWORD
}
 Vlk widget timline notify messages. More...
 
enum  eVlkWidgetTimeBarType {
  eVlkWidgetTimeBarType_Unknown,
  eVlkWidgetTimeBarType_Entity,
  eVlkWidgetTimeBarType_Action,
  eVlkWidgetTimeBarType_Event,
  eVlkWidgetTimeBarType_ForceDWORD
}
 Time bar types. More...
 
enum  eVlkWidgetTimeBarSerializeFlags {
  eVlkWidgetTimeBarSerializeFlags_None,
  eVlkWidgetTimeBarSerializeFlags_TimelineOnly,
  eVlkWidgetTimeBarSerializeFlags_Selected,
  eVlkWidgetTimeBarSerializeFlags_Basic,
  eVlkWidgetTimeBarSerializeFlags_Copy,
  eVlkWidgetTimeBarSerializeFlags_Reload,
  eVlkWidgetTimeBarSerializeFlags_ForceDWORD
}
 Vlk widget time bar flags. More...
 
enum  eVlkWidgetTimelineViewMode {
  eVlkWidgetTimelineViewMode_Timeline,
  eVlkWidgetTimelineViewMode_BaseInspector,
  eVlkWidgetTimelineViewMode_AdvancedInspector,
  eVlkWidgetTimelineViewMode_TreeOnly,
  eVlkWidgetTimelineViewMode_ForceDWORD
}
 Timeline view mode. More...
 
enum  eVlkWidgetFilterDisplayFlags {
  eVlkWidgetFilterDisplayFlags_None,
  eVlkWidgetFilterDisplayFlags_NoButtonsPlayPauseStop,
  eVlkWidgetFilterDisplayFlags_NoButtonReload,
  eVlkWidgetFilterDisplayFlags_NoButtonDelete,
  eVlkWidgetFilterDisplayFlags_NoButtonViewModeTimeline,
  eVlkWidgetFilterDisplayFlags_NoButtonViewModeBaseInspector,
  eVlkWidgetFilterDisplayFlags_NoButtonViewModeAdvancedInspector,
  eVlkWidgetFilterDisplayFlags_NoButtonViewModeTreeOnly,
  eVlkWidgetFilterDisplayFlags_NoButtonHideActions,
  eVlkWidgetFilterDisplayFlags_NoButtonHideEvents,
  eVlkWidgetFilterDisplayFlags_NoButtonHideAnimations,
  eVlkWidgetFilterDisplayFlags_NoButtonHideChildren,
  eVlkWidgetFilterDisplayFlags_NoButtonHideLights,
  eVlkWidgetFilterDisplayFlags_NoButtonHideCameras,
  eVlkWidgetFilterDisplayFlags_NoButtonFilterEntityClass,
  eVlkWidgetFilterDisplayFlags_NoButtonFilterEntityName,
  eVlkWidgetFilterDisplayFlags_NoButtonFilterEntityFlags,
  eVlkWidgetFilterDisplayFlags_NoButtonsExplore,
  eVlkWidgetFilterDisplayFlags_HideActions,
  eVlkWidgetFilterDisplayFlags_HideEvents,
  eVlkWidgetFilterDisplayFlags_HideAnimations,
  eVlkWidgetFilterDisplayFlags_HideChildren,
  eVlkWidgetFilterDisplayFlags_NoButtonsHide,
  eVlkWidgetFilterDisplayFlags_NoButtonsViewMode,
  eVlkWidgetFilterDisplayFlags_NoButtonsFilterFilterEntity,
  eVlkWidgetFilterDisplayFlags_ForceDWORD
}
 Timeline filter display flags. More...
 

Functions

iVlkUtils * GetVlkUtils ()
 
ni::iUnknownNew_Vlk_VlkUtils (const ni::Var &, const ni::Var &)
 
iResources * GetResources ()
 
iUnknown * New_VlkEditor_Resources (const Var &, const Var &)
 
iUnknown * New_ResourceFileLoader_zip (const Var &avarA, const Var &)
 

Macro Definition Documentation

#define VLK_ENTITY_MSGID (   TYPE,
  BYTE 
)

Typedef Documentation

typedef ni::tU32 tVlkFingerIDFlags

Vlk Finger ID flags type.

See also
vlk::eVlkFingerIDFlags
typedef ni::SinkList<iVlkActionSink> tVlkActionSinkLst

Vlk action sink list.

typedef ni::tU32 tVlkEntitySerializeFlags

Entity serialize flags type.

See also
ni::eVlkEntitySerializeFlags
typedef ni::tU32 tVlkEntityFlags

Entity flags type.

typedef ni::tU32 tVlkEntityClassFlags

Entity class flags type.

typedef ni::tInterfaceCVec<iVlkEntity> tVlkEntityPtrCVec

VlkEntity smart pointer vector.

typedef ni::tU32 tVlkLayerFlags

Vlk layer flags type.

typedef ni::tU32 tVlkWidgetTimeBarSerializeFlags

Vlk widget time bar flags type.

typedef ni::tU32 tVlkWidgetFilterDisplayFlags

Vlk widget filter display flags type.

See also
vlk::eVlkWidgetFilterDisplayFlags

Enumeration Type Documentation

enum eVlkPlaybackRenderMode

Vlk playback mode.

Enumerator
eVlkPlaybackRenderMode_Regular 

Regular rendering mode, 3D on a 2D screen. All cameras are left untouched.

eVlkPlaybackRenderMode_AR 

AR rendering mode. The timeline's camera position and orientation is determined by the device.

eVlkPlaybackRenderMode_VR 

VR rendering mode. The timeline's camera orientation is determined by the device.

eVlkPlaybackRenderMode_ForceDWORD 
enum eVlkPlaybackOrientation

Vlk orientation mode.

Enumerator
eVlkPlaybackOrientation_Landscape 
eVlkPlaybackOrientation_Portrait 
eVlkPlaybackOrientation_ForceDWORD 
enum eVlkState

Vlk states.

Enumerator
eVlkState_Physics 

Physics enabled/disabled. (default eTrue)

eVlkState_Timelines 

Timelines enabled/disabled. (default eTrue)

Remarks
If disabled all automatic animations update will be stopped.
eVlkState_Animations 

Animations enabled/disabled. (default eTrue)

eVlkState_EditMode 

Enable/disable edit mode. (default eFalse)

Remarks
This will broadcast the eVlkEntity_Enter/LeaveEditMode messages to the game entities.
eVlkState_EntityUpdateRate 

Entities logic number of updates per seconds. (default: 1/60)

Remarks
Set to zero to update once for every update call.
eVlkState_ParticlesLod 

Lod of the particle systems.

Remarks
The range is 0-1
This should be used on lower end devices to lower the number of particles
This lower the maximum number of particles and the rate of emission
eVlkState_PlaybackRenderMode 

Playback render mode. (default eVlkPlaybackRenderMode_Regular)

eVlkState_Last 
eVlkState_ForceDWORD 
enum eVlkFingerIDFlags

Vlk Finger ID flags.

Enumerator
eVlkFingerIDFlags_Touch0 
eVlkFingerIDFlags_Touch1 
eVlkFingerIDFlags_Touch2 
eVlkFingerIDFlags_Touch3 
eVlkFingerIDFlags_Touch4 
eVlkFingerIDFlags_Touch5 
eVlkFingerIDFlags_Touch6 
eVlkFingerIDFlags_Touch7 
eVlkFingerIDFlags_Touch8 
eVlkFingerIDFlags_Touch9 
eVlkFingerIDFlags_MouseLeft 
eVlkFingerIDFlags_MouseRight 
eVlkFingerIDFlags_MouseMiddle 
eVlkFingerIDFlags_PointerLocked 
eVlkFingerIDFlags_All 
enum eVlkEntityCameraType

Vlk camera type.

Enumerator
eVlkEntityCameraType_Regular 

Regular rendering mode, 3D on a 2D screen. All cameras are left untouched.

eVlkEntityCameraType_AR 

AR rendering mode. The timeline's camera position and orientation is determined by the device.

eVlkEntityCameraType_VR 

VR rendering mode. The timeline's camera orientation is determined by the device.

eVlkEntityCameraType_ForceDWORD 
enum eVlkEntityMessageType

Vlk entity message type.

Remarks
To get the type of a message : niMessageID_GetD(MSGID)
Enumerator
eVlkEntityMessageType_System 

System messages.

Remarks
System messages will never be sent to an observer.
eVlkEntityMessageType_Edition 

Edition messages.

eVlkEntityMessageType_LifeTime 

Life time messages.

eVlkEntityMessageType_Serialize 

Serialization messages.

eVlkEntityMessageType_Status 

Status messages.

eVlkEntityMessageType_Layer 

Layer messages.

eVlkEntityMessageType_Update 

Update messages.

eVlkEntityMessageType_Rendering 

Rendering messages.

eVlkEntityMessageType_Physics 

Physics messages.

Remarks
Can be intercepted by an event timeline.
eVlkEntityMessageType_Input 

Input messages.

Remarks
Can be intercepted by an event timeline.
eVlkEntityMessageType_Datatable 

Datatable messages.

Remarks
Can be intercepted by an event timeline.
eVlkEntityMessageType_Action 

Action messages.

Remarks
Can be intercepted by an event timeline.
eVlkEntityMessageType_Custom 

Custom messages.

Remarks
Can be intercepted by an event timeline.
eVlkEntityMessageType_ForceDWORD 
enum eVlkEntityMessage

Vlk entity message.

Enumerator
eVlkEntityMessage_SinkAttached 

A sink has been attached to an entity.

Parameters
Aunused
Bunused
Remarks
This is sent only to the sink concerned. To be used as constructor for the sink.
If the entity has already been loaded and has already entered a level the sink will never receive the Load and EnterLevel messages.
eVlkEntityMessage_SinkDetached 

A sink has been detached of the entity.

Parameters
Aunused
Bunused
Remarks
This is sent only to the sink concerned. To be used as constructor for the sink.
eVlkEntityMessage_ObserverNotify 

Notify an observer of a message.

Parameters
Athe entity that received the notified message.
BiMessage instance that contains the message.
eVlkEntityMessage_EnterEditMode 

Enter edit mode.

See also
vlk::iVlk::SetEditMode
Parameters
Aunused
Bunused
eVlkEntityMessage_LeaveEditMode 

Leave edit mode.

See also
vlk::iVlk::SetEditMode
Parameters
Aunused
Bunused
eVlkEntityMessage_Selected 

Sent when the entity is selected.

Parameters
Avlk selection object in which the entity is selected
Bunused
eVlkEntityMessage_Unselected 

Sent when the entity is unselected.

Parameters
Avlk selection object in which the entity is unselected
Bunused
eVlkEntityMessage_EditCommand 

Edit Command.

See also
vlk::iVlk::SetEditMode
Parameters
AiHString, the command's name ("the-command-name")
Bthe command's parameter
eVlkEntityMessage_ChildAttached 

A child entity been attached to this entity.

Parameters
Ais the entity attached.
Bthe child's index in the entity
eVlkEntityMessage_ChildDetached 

A child entity has been detached to this entity.

Parameters
Ais the entity detached.
Bthe child's index in the entity
eVlkEntityMessage_SetParent 

The parent of the entity changed.

Parameters
Aunused
Bunused
eVlkEntityMessage_TimelineAdded 

Timeline added.

Parameters
Athe timeline added
Bthe timeline's index in the entity
eVlkEntityMessage_TimelineRemoved 

Timeline removed.

Parameters
Athe timeline removed //!
Bthe timeline's index in the entity
eVlkEntityMessage_ActionAdded 

Action added.

Parameters
Athe action added
Bthe action's index in the timeline
eVlkEntityMessage_ActionRemoved 

Action removed.

Parameters
Athe action removed
Bthe action's index in the timeline
eVlkEntityMessage_MaterialAdded 

Material added.

Parameters
Athe material added
Bunused
eVlkEntityMessage_MaterialRemoved 

Material removed.

Parameters
Athe material removed
Bunused
eVlkEntityMessage_MaterialLibraryChanged 

Material library changed.

Parameters
Aunused
Bunused
eVlkEntityMessage_Invalidate 

The entity is being invalidated.

Parameters
Aunused
Bunused
eVlkEntityMessage_SetName 

The name of the entity changed.

Parameters
Aunused
Bunused
eVlkEntityMessage_SetGroup 

The group of the entity changed.

Parameters
Aunused
Bunused
eVlkEntityMessage_SetFlags 

The flags have changed.

Parameters
Aunused
Bunused
eVlkEntityMessage_SetEnabled 

The enabled status of the entity has changed.

Parameters
Aunused
Bunused
eVlkEntityMessage_Timer 

Sent when a timer expires.

Parameters
Atimer id
Btimer duration
eVlkEntityMessage_Update 

Sent when the entity should be updated, at the EntityUpdateRate timestep.

Parameters
Aunused
Bunused
eVlkEntityMessage_UpdateFrame 

Sent when the entity should be updated, once per frame.

Parameters
Aunused
Bunused
eVlkEntityMessage_RenderBase 

Sent when base custom rendering should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_RenderTranslucent 

Sent when translucent custom rendering should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_RenderOverlay 

Sent when 'overlay' rendering should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_RenderDebug 

Sent when debug rendering should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_Render2D 

Sent when 2d rendering should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_RenderPostProcess 

Sent when post processing rendering should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_RenderBackground 

Sent when background rendering should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_RenderEditMode 

Sent when edit mode rendering should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_RenderSetup 

Sent when rendering setup should be done.

Parameters
Ani::iPainterDrawSet
Bni::iPainterRenderContext
eVlkEntityMessage_EnterCollision 

Sent when entering in collision with any of the entities collide object.

Parameters
Ais the entity's collide object that triggered the event
Bis the collide object (in an other entity) that collided with the entity's object
eVlkEntityMessage_LeaveCollision 

Sent when no collision occurs anymore with a previously collided object.

Parameters
Ais the entity's collide object that triggered the event
Bis the collide object (in an other entity) that collided with the entity's object
eVlkEntityMessage_EnterRayHit 

Sent when a ray action "hits" the entity.

Parameters
ARayClass
BThe ray hit position
eVlkEntityMessage_LeaveRayHit 

Sent when a ray action that hit the entity ends or doesnt hit the entity anymore.

Parameters
Ais the RayClass
Bunused
eVlkEntityMessage_KeyDown 

Key down event.

Parameters
AeKey
BeKeyMod
Remarks
Sent to the input capture entity if there's one, else to all input target entities.
eVlkEntityMessage_KeyUp 

Key up event.

Parameters
AeKey
BeKeyMod
Remarks
Sent to the input capture entity if there's one, else to all input target entities.
eVlkEntityMessage_KeyChar 

Key char event.

Parameters
AtU32, unicode code point of the character entered
Bunused
Remarks
Sent to the input capture entity if there's one, else to all input target entities.
eVlkEntityMessage_FingerDown 

Finger down.

Parameters
Afinger index.
Bfinger position, client relative, and pressure. Vec3(client x, client y, pressure).
eVlkEntityMessage_FingerUp 

Finger up.

Parameters
Afinger index.
Bfinger position, client relative, and pressure. Vec3(client x, client y, pressure).
eVlkEntityMessage_FingerMove 

Finger moved.

Parameters
Afinger index.
Bfinger position, client relative, and pressure. Vec3(client x, client y, pressure).
eVlkEntityMessage_FingerRelativeMove 

Finger relative movement.

Parameters
Afinger index.
Bfinger movement delta, and pressure. Vec3(delta x, delta y, pressure).
eVlkEntityMessage_GameCtrl 

Game controller event.

Parameters
AiGameCtrl
Bunused.
Remarks
Sent to the input capture entity if there's one, else to all input target entities.
eVlkEntityMessage_GameCtrlButtonDown 

Game controller button down.

Parameters
AiGameCtrl
Bthe game controller button pressed.
Remarks
Sent to the input capture entity if there's one, else to all input target entities.
eVlkEntityMessage_GameCtrlButtonUp 

Game controller button up.

Parameters
AiGameCtrl
Bthe game controller button released.
Remarks
Sent to the input capture entity if there's one, else to all input target entities.
eVlkEntityMessage_Pinch 

Pinch gesture.

Parameters
Ascale.
eVlkEntityMessage_SerializeBase 

SerializeBase message.

Parameters
AiDataTable interface where the entity should be written/read.
Bthe entity serialize flags
See also
eVlkEntitySerializeFlags.
vlk::iVlk::SerializeEntity
vlk::iVlkEntity::SerializeBase
Remarks
Not called if the NoRoot serialize flag is set.
By default copy the entity's data table.
eVlkEntityMessage_SerializeEntity 

SerializeEntity message.

Parameters
AiDataTable interface where the entity should be written/read.
Bthe entity serialize flags
See also
eVlkEntitySerializeFlags.
vlk::iVlk::SerializeEntity
Remarks
This is always called, no matter what the serialize flags are.
eVlkEntityMessage_SerializeChildren 

SerializeChildren message.

Parameters
AiDataTable interface where the entity should be written/read.
Bthe entity serialize flags
See also
eVlkEntitySerializeFlags.
vlk::iVlk::SerializeEntity
vlk::iVlkEntity::SerializeChildren
Remarks
Not called if the Children serialize flag is not set.
eVlkEntityMessage_SerializeTimeline 

SerializeTimeline message.

Parameters
AiDataTable interface where the entity should be written/read.
Bthe entity serialize flags
See also
eVlkEntitySerializeFlags.
vlk::iVlk::SerializeEntity
vlk::iVlkEntity::SerializeTimeline
Remarks
Not called if the Timeline serialize flag is not set.
eVlkEntityMessage_SerializeMaterials 

SerializeMaterials message.

Parameters
AiDataTable interface where the materials should be written/read.
Bthe entity serialize flags
See also
eVlkEntitySerializeFlags.
vlk::iVlk::SerializeEntity
vlk::iVlkEntity::SerializeMaterials
Remarks
Not called if the Materials serialize flag is not set.
eVlkEntityMessage_SerializeFinalize 

SerializeFinalize message.

Parameters
AiDataTable interface where the entity is written/read.
Bthe entity serialize flags
See also
eVlkEntitySerializeFlags.
vlk::iVlk::SerializeEntity
vlk::iVlkEntity::SerializeFinalize
Remarks
Called at the end of the serialization.
eVlkEntityMessage_PropertyChanged 

A property in entity's properties datatable has changed.

Parameters
Ani::iDataTable* the datatable where the property changed
Bni::tU32 property index
eVlkEntityMessage_SetLayer 

The entity has been attached into another layer.

Parameters
Aunused
Bunused
eVlkEntityMessage_SetLayerCollideScene 

The entity's layer collide scene has changed.

Parameters
Athe new collide scene (ni::iCollideScene)
Bthe old collide scene (ni::iCollideScene)
Remarks
Sent after SetLayer when attached into a layer which has a collide scene.
Layer entities receive this message only when their own collide scene is changed.
eVlkEntityMessage_SetLayerPainterDrawSet 

The entity's layer painter draw set has changed.

Parameters
Athe new painter draw set (ni::iPainterDrawSet)
Bthe old painter draw set (ni::iPainterDrawSet)
Remarks
Sent after SetLayer when attached into a layer which has a collide scene.
Layer entities receive this message only when their own painter draw set is changed.
eVlkEntityMessage_SetLayerVizCell 

The entity's layer viz cell has changed.

Parameters
Athe new viz cell (ni::iVizCell)
Bthe old viz cell (ni::iVizCell)
Remarks
Sent after SetLayer when attached into a layer which has a collide scene.
Layer entities receive this message only when their own painter draw set is changed.
eVlkEntityMessage_SetLevel 

The entity has been attached into a level.

Parameters
Athe new level's entity
Bthe previous level's entity, if any
eVlkEntityMessage_LevelLoaded 

The whole level has finished loading.

Parameters
Athe level's entity
Bnull
Remarks
Broadcasted to the level itself and all its children entities. This is broadcasted only once by vlk::iVlkLevel::LoadEx (and indirectly by vlk::iVlkLevel::Load).
eVlkEntityMessage_ActionSucceeded 

An action sent a succeeded code.

Parameters
Athe success category.
Bunused.
eVlkEntityMessage_ActionFailed 

An action sent a failure code.

Parameters
Athe failure category.
Bunused.
eVlkEntityMessage_PlaybackRoot 

Root timeline's playback state changed.

Parameters
Anew playback state
Bprevious playback state
eVlkEntityMessage_PlaybackPlay 

Notify that the root timeline's playback started.

Parameters
Aunused
Bunused
eVlkEntityMessage_PlaybackStop 

Notify that the root timeline's that playback stopped.

Parameters
Aunused
Bunused
eVlkEntityMessage_PlaybackPause 

Notify that the root timeline's that playback has been (un)paused.

Parameters
Aunused
Bunused
eVlkEntityMessage_PlaybackRenderMode 

Notify of a change in the playback's rendering mode.

Parameters
Athe new rendering mode
Bthe previous renderin mode
eVlkEntityMessage_PlaybackOrientation 

Notify of a change in the playback's orientation or viewport size.

Parameters
Athe new orientation
Bthe previous orientation
eVlkEntityMessage_Custom0 

Custom message 0, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Custom1 

Custom message 1, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Custom2 

Custom message 2, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Custom3 

Custom message 3, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Custom4 

Custom message 4, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Custom5 

Custom message 5, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Custom6 

Custom message 6, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Custom7 

Custom message 7, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Entity0 

Entity message 0, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Entity1 

Entity message 1, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Entity2 

Entity message 2, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Entity3 

Entity message 3, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Entity4 

Entity message 4, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Entity5 

Entity message 5, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Entity6 

Entity message 6, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_Entity7 

Entity message 7, user defined.

Parameters
Auser defined.
Buser defined.
eVlkEntityMessage_ForceDWORD 
enum eVlkEntityFlags

Entity flags.

Enumerator
eVlkEntityFlags_Default 

Default.

eVlkEntityFlags_Relative 

The entity transform is relative to its parent.

eVlkEntityFlags_LocalTimeline 

The entity has its own local timeline.

eVlkEntityFlags_LocalStatus 

The entity's out of time state does not affect its status (visible/enabled).

eVlkEntityFlags_ChildrenLocalStatus 

The entity's status (visible/enabled) is not inherited.

eVlkEntityFlags_TransformFrozen 

The entity has its transform frozen, it cant be modified anymore.

Remarks
When set the transform states are cloned, everytime it is updated the transform is copied from the saved state.
Only SerializeRead can change the transform.
eVlkEntityFlags_DontSerialize 

Don't serialize the entity.

eVlkEntityFlags_Timer 

A timer is set.

eVlkEntityFlags_NotifyPropertyChanged 

Send the eVlkEntityMessage_SetProperty message when the value of a property changed.

eVlkEntityFlags_BlackBox 

Black boxed entity.

eVlkEntityFlags_ForceDWORD 
enum eVlkEntityClassFlags

Vlk entity class flags.

Remarks
Class flags are not serialized, the must be set by the OnSinkAttached of an entity class's sink.
Enumerator
eVlkEntityClassFlags_Dummy 

The entity is a dummy, minimum of processing is done on Dummy nodes, they are meant to be used only as tree structure entities.

eVlkEntityClassFlags_Light 

The entity implements the iPainterLight interface.

eVlkEntityClassFlags_Camera 

The entity implements the iVlkCamera interface.

eVlkEntityClassFlags_Layer 

The entity is a layer.

eVlkEntityClassFlags_Character 

The entity implements the iCharacter interface.

eVlkEntityClassFlags_Level 

The entity is a level.

eVlkEntityClassFlags_NotifyPropertyChanged 

Send the eVlkEntityMessage_SetProperty message when the value of a property changed.

Remarks
This is the same as the regular entity flag excepted that it is always enabled no matter what the serialization says. It is necessary for entity type which use the properties and notifications as basic mechanism (such as most PostProcess entities).
It is intentionally the same value as vlk::eVlkEntityFlags_NotifyPropertyChanged
eVlkEntityClassFlags_NoTranslate 

The entity can't be translated.

eVlkEntityClassFlags_NoRotate 

The entity can't be rotated.

eVlkEntityClassFlags_NoScale 

The entity can't be scaled.

eVlkEntityClassFlags_UniformScale 

The entity can be scaled uniformly only.

eVlkEntityClassFlags_SelectedRenderEditMode 

The entity's default (un)selected message handler will (un)set the EditMode painter object flags when the entity is (un)selected.

Remarks
This is the default for all Character, Camera and Light class flag entities, aswell as all entities that have some painter object flags set. To completly disable that behavior in anycase override the selected and unselected messages.
eVlkEntityClassFlags_InputTarget 

The entity receives input.

eVlkEntityClassFlags_ForceDWORD 
enum eVlkEntitySerializeFlags

Entity serialize flags.

Enumerator
eVlkEntitySerializeFlags_Write 

Serialize write.

Remarks
Read or Write must be specified, both can't be specified simultaneously.
This is intentionally the same as ni::eSerializeFlags_Write
eVlkEntitySerializeFlags_Read 

Serialize read.

Remarks
Read or Write must be specified, both can't be specified simultaneously.
This is intentionally the same as ni::eSerializeFlags_Read
eVlkEntitySerializeFlags_Timeline 

Serialize (read/write) the timeline of the entity.

eVlkEntitySerializeFlags_Children 

Serialize (read/write) the children of the entity.

eVlkEntitySerializeFlags_NoRoot 

Don't serialize the root entity's information.

Remarks
What is considered the root entity is the entity passed to SerializeLayout.
eVlkEntitySerializeFlags_NoTableNameCheck 

No table name check will be performed.

Remarks
In write mode means that the name of the datatable wont be modified.
eVlkEntitySerializeFlags_Materials 

Whether to serialize the entity's materials.

eVlkEntitySerializeFlags_IsChild 

Serialize (read/write) the entity as a child of another entity.

Remarks
This will serialize the local_matrix instead of the world matrix.
eVlkEntitySerializeFlags_PropertyBox 

Edition property box serialization.

Remarks
Additional or different informations that are more suited for edition should be serialized when writting in a property box.
This is intentionally the same as ni::eSerializeFlags_TypeInfoMetadata.
eVlkEntitySerializeFlags_ForceDWORD 
enum eVlkEntityPrimitiveType

Standard primitive entity type.

Enumerator
eVlkEntityPrimitiveType_Box 

Box type.

eVlkEntityPrimitiveType_Sphere 

Sphere type.

eVlkEntityPrimitiveType_Cylinder 

Cylinder type.

eVlkEntityPrimitiveType_PlaneVt 

Vertical plane type.

eVlkEntityPrimitiveType_PlaneHz 

Horizontal plane type.

eVlkEntityPrimitiveType_ForceDWORD 
enum eVlkEntityTextAnchorH

Text entity horizontal anchor points.

Enumerator
eVlkEntityTextAnchorH_Center 
eVlkEntityTextAnchorH_Left 
eVlkEntityTextAnchorH_Right 
eVlkEntityTextAnchorH_ForceDWORD 
enum eVlkEntityTextAnchorV

Text entity vertical anchor points.

Enumerator
eVlkEntityTextAnchorV_Center 
eVlkEntityTextAnchorV_Top 
eVlkEntityTextAnchorV_Bottom 
eVlkEntityTextAnchorV_ForceDWORD 
enum eVlkFactoryMessage
Enumerator
eVlkFactoryMessage_Cached 
eVlkFactoryMessage_Restored 
eVlkFactoryMessage_SpawnEntity 
eVlkFactoryMessage_SpawnEntityGrid 
eVlkFactoryMessage_CacheEntity 
eVlkFactoryMessage_CacheAllEntities 
enum eVlkLayerFlags

Vlk layer type.

Enumerator
eVlkLayerFlags_None 

No flags.

eVlkLayerFlags_CollideScene 

Using an independant collide scene.

eVlkLayerFlags_PainterDrawSet 

Using an independant painter draw set.

eVlkLayerFlags_DontPaintRenderTargets 

Don't paint render targets in this layer.

eVlkLayerFlags_VizCell 

Using an independant viz cell.

eVlkLayerFlags_Camera 

Using an independant camera.

Remarks
Layers with their own camera reset the depth/stencil buffer and draw their background regardless of the rendering mode (
See also
eVlkPlaybackRenderMode).
eVlkLayerFlags_ViewportStretch 

Stretch the viewport in the parent layer's viewport, preserving the aspect ratio.

eVlkLayerFlags_ViewportCenterH 

Center viewport horizontally in the parent layer's viewport.

eVlkLayerFlags_ViewportCenterV 

Center viewport vertically in the parent layer's viewport.

eVlkLayerFlags_ViewportRight 

Align the viewport position on the right edge of the parent layer's viewport.

Remarks
By default the viewport position is aligned on the left edge.
eVlkLayerFlags_ViewportBottom 

Align the viewport position on the bottom edge of the parent layer's viewport.

Remarks
By default the viewport position is aligned on the top edge.
eVlkLayerFlags_DynamicsScene 

Using an independant dynamics scene. Implies a CollideScene.

eVlkLayerFlags_RenderTarget 

Render the layer in its own render target.

eVlkLayerFlags_ForceDWORD 
enum eVlkPlayback

Timeline playback states.

Enumerator
eVlkPlayback_Stopped 
eVlkPlayback_Playing 
eVlkPlayback_Paused 
eVlkPlayback_ForceDWORD 
enum eVlkLicense
Enumerator
eVlkLicense_Free 
eVlkLicense_Individual 
eVlkLicense_Business 
eVlkLicense_Enterprise 
eVlkLicense_ErrorUnknown 
eVlkLicense_ErrorNoDigest 
eVlkLicense_ErrorNoSig 
eVlkLicense_ErrorReadSig 
eVlkLicense_ErrorVerify 
eVlkLicense_ForceDWORD 
enum eVlkWidgetTimelineMessage

Vlk widget timeline custom messages.

Enumerator
eVlkWidgetTimelineMessage_UpdateTreeContextMenu 

Sent when the tree item context menu should be updated, that is before it is opened.

Remarks
Use the Tree* methods to determin what is the current selection.
eVlkWidgetTimelineMessage_UpdateToolbar 

Sent when the toolbar should be updated.

eVlkWidgetTimelineMessage_ForceDWORD 
enum eVlkWidgetTimelineCmd

Vlk widget timline notify messages.

Remarks
The commands are sent to the timeline widget itself, so a sink should be set on the timeline widget to intercept the them. By default the commands call the corresponding Cmd* method.
Enumerator
eVlkWidgetTimelineCmd_FirstCmd 

First command ID.

eVlkWidgetTimelineCmd_CmdPlay 

Play the root timeline.

See also
vlk::iVlkWidgetTimeline::CmdPlay
eVlkWidgetTimelineCmd_CmdPause 

Pause the root timeline.

See also
vlk::iVlkWidgetTimeline::CmdPause
eVlkWidgetTimelineCmd_CmdStop 

Stop the root timeline.

See also
vlk::iVlkWidgetTimeline::CmdStop
eVlkWidgetTimelineCmd_CmdAddAction 

Add an action in the selected vlk::timeline.

See also
vlk::iVlkWidgetTimeline::CmdAddAction
Parameters
extra1iDataTable, is the datatable to add
eVlkWidgetTimelineCmd_CmdAddTimeline 

Add a new timeline in the selected vlk::entity.

See also
vlk::iVlkWidgetTimeline::CmdAddTimeline
Parameters
extra1iHString, is the name of the new timeline
eVlkWidgetTimelineCmd_CmdDeleteSelection 

Delete the selection.

See also
vlk::iVlkWidgetTimeline::CmdDeleteSelection
eVlkWidgetTimelineCmd_CmdReloadSelection 

Reload the selection.

See also
vlk::iVlkWidgetTimeline::CmdReloadSelection
eVlkWidgetTimelineCmd_CmdSetEnabled 

Set the selection's enabled status.

See also
vlk::iVlkWidgetTimeline::CmdSetEnabled
Parameters
extra1bool, whether to set enabled or disabled
eVlkWidgetTimelineCmd_CmdExplore 

Explore the selected entity.

See also
vlk::iVlkWidgetTimeline::CmdExplore
eVlkWidgetTimelineCmd_CmdExploreUp 

Explore the parent's entity.

See also
vlk::iVlkWidgetTimeline::CmdExploreUp
eVlkWidgetTimelineCmd_CmdAddTimelineEx 

Add a new timeline in the selected vlk::entity.

See also
vlk::iVlkWidgetTimeline::CmdAddTimelineEx
Parameters
extra1iHString, is the name of the new timeline
extra2iHString, is the name of the new timeline event
eVlkWidgetTimelineCmd_CmdAddEvent 

Add a new timeline in the selected vlk::entity.

See also
vlk::iVlkWidgetTimeline::CmdAddEvent
Parameters
extra1iHString, is the name of the new timeline
eVlkWidgetTimelineCmd_CmdZoomIn 

Zoom in the timeline.

See also
vlk::iVlkWidgetTimeline::CmdZoomIn
eVlkWidgetTimelineCmd_CmdZoomOut 

Zoom out the timeline.

See also
vlk::iVlkWidgetTimeline::CmdZoomOut
eVlkWidgetTimelineCmd_CmdZoomDefault 

Zoom to default the timeline.

See also
vlk::iVlkWidgetTimeline::CmdZoomDefault
eVlkWidgetTimelineCmd_ForceDWORD 
enum eVlkWidgetTimeBarType

Time bar types.

Enumerator
eVlkWidgetTimeBarType_Unknown 

Unknown.

eVlkWidgetTimeBarType_Entity 

Entity.

eVlkWidgetTimeBarType_Action 

Action.

eVlkWidgetTimeBarType_Event 

Event/Timeline.

eVlkWidgetTimeBarType_ForceDWORD 
enum eVlkWidgetTimeBarSerializeFlags

Vlk widget time bar flags.

Enumerator
eVlkWidgetTimeBarSerializeFlags_None 

Default.

eVlkWidgetTimeBarSerializeFlags_TimelineOnly 

Only the timeline should be serialized.

eVlkWidgetTimeBarSerializeFlags_Selected 

New selection serialization.

eVlkWidgetTimeBarSerializeFlags_Basic 

Serialize basic properties.

eVlkWidgetTimeBarSerializeFlags_Copy 

Copy serialization.

eVlkWidgetTimeBarSerializeFlags_Reload 

Reload the widget.

eVlkWidgetTimeBarSerializeFlags_ForceDWORD 
enum eVlkWidgetTimelineViewMode

Timeline view mode.

Enumerator
eVlkWidgetTimelineViewMode_Timeline 

Show the timebars.

eVlkWidgetTimelineViewMode_BaseInspector 

Show the basic inspector.

eVlkWidgetTimelineViewMode_AdvancedInspector 

Show the advanced inspector.

eVlkWidgetTimelineViewMode_TreeOnly 

Only the tree view (left part) is visible.

eVlkWidgetTimelineViewMode_ForceDWORD 
enum eVlkWidgetFilterDisplayFlags

Timeline filter display flags.

Enumerator
eVlkWidgetFilterDisplayFlags_None 

None set.

eVlkWidgetFilterDisplayFlags_NoButtonsPlayPauseStop 

Dont display the play/pause/stop buttons.

eVlkWidgetFilterDisplayFlags_NoButtonReload 

Dont display the reload button.

eVlkWidgetFilterDisplayFlags_NoButtonDelete 

Dont diplsay the delete button.

eVlkWidgetFilterDisplayFlags_NoButtonViewModeTimeline 

Dont display the view mode timeline button.

eVlkWidgetFilterDisplayFlags_NoButtonViewModeBaseInspector 

Dont display the view mode base inspector button.

eVlkWidgetFilterDisplayFlags_NoButtonViewModeAdvancedInspector 

Dont display the view mode advanced inspector button.

eVlkWidgetFilterDisplayFlags_NoButtonViewModeTreeOnly 

Dont display the view mode tree only button.

eVlkWidgetFilterDisplayFlags_NoButtonHideActions 

Dont display the hide actions button.

eVlkWidgetFilterDisplayFlags_NoButtonHideEvents 

Dont display the hide events button.

eVlkWidgetFilterDisplayFlags_NoButtonHideAnimations 

Dont display the hide animations button.

eVlkWidgetFilterDisplayFlags_NoButtonHideChildren 

Dont display the hide lights button.

eVlkWidgetFilterDisplayFlags_NoButtonHideLights 

Dont display the hide lights button.

eVlkWidgetFilterDisplayFlags_NoButtonHideCameras 

Dont display the hide cameras button.

eVlkWidgetFilterDisplayFlags_NoButtonFilterEntityClass 

Dont display the entity class filter widget.

eVlkWidgetFilterDisplayFlags_NoButtonFilterEntityName 

Dont display the entity name filter widget.

eVlkWidgetFilterDisplayFlags_NoButtonFilterEntityFlags 

Dont display the entity flags filter widget.

eVlkWidgetFilterDisplayFlags_NoButtonsExplore 

Dont display the explore/up buttons.

eVlkWidgetFilterDisplayFlags_HideActions 

Hide actions.

eVlkWidgetFilterDisplayFlags_HideEvents 

Hide events.

eVlkWidgetFilterDisplayFlags_HideAnimations 

Hide animations.

eVlkWidgetFilterDisplayFlags_HideChildren 

Hide children.

eVlkWidgetFilterDisplayFlags_NoButtonsHide 

Dont display any hide button.

eVlkWidgetFilterDisplayFlags_NoButtonsViewMode 

Dont display any view mode buttons.

eVlkWidgetFilterDisplayFlags_NoButtonsFilterFilterEntity 

Dont display the entity filter buttons.

eVlkWidgetFilterDisplayFlags_ForceDWORD 

Function Documentation

iVlkUtils* vlk::GetVlkUtils ( )
ni::iUnknown * New_Vlk_VlkUtils ( const ni::Var ,
const ni::Var  
)
iResources* ni::GetResources ( )
ni::iUnknown * New_VlkEditor_Resources ( const Var &  ,
const Var &   
)
ni::iUnknown * New_ResourceFileLoader_zip ( const Var &  avarA,
const Var &   
)