VKC Item Object

VKC Item Object is used to instantiate a dynamic object, which is based on a pre-exported .heo file, or using a vrm, hrm, or glb format model.

Available methods for this object type

• Equals
• GetName
• SetPos
• GetPos
• GetWorldPos
• SetQuaternion
• GetQuaternion
• GetWorldQuaternion
• GetWorldRotate
• GetScale
• SetScale
• MovePos
• IsMoving
• Play
• Stop
• IsPlay
• Pause
• Restart
• SetPlayTime
• GetPlayTime
• SetShow
• IsShow
• ChangeMotion
• LoadMotion
• LoadMotion
• FacialEmoteFixed
• Load
• Unload
• IsLoading
• IsLoaded
• GetNodeIndexByName
• GetNodeNameByIndex
• SetShowNode
• IsShowNode
• SetUVOffset
• PlayVideo
• StopVideo
• IsPlayVideo
• ReplaceItem
• ReplaceTexture
• SetProperty
• GetProperty
• CallComponentMethod
• SetOverridesProperty
• GetOverridesProperty

Settings

Basic Settings

Label	Initial Value	Function
Show	true	Toggle object visibility.
File Mode		Allocate a heo, vrm, hrm, or glb file. If a vrm file has a Compressed Texture, specify the texture file on hrm.
Scene Preview	false	Preview the object instantiation on the Unity Scene. Further details are on "Previewing Objects" article.
Enable Bone	false	(only for vrm, hrm, and gbl) Enable if you want to play armature animation.
Circle Shadow	false	Sets to draw a circle shadow.
Look at Camera	false	Make the object face towards the camera at all times.
Object Mode	None	Choose from None, Pose, and Motion. If you choose Pose or Motion, you will need to additionally specify an .hem file.
Pickable	false	Enable the grab function.

Pickable

Label	Initial Value	Function
Display Name (ja)	""	Display name in Japanese.
Display Name (en)	""	Display name in English.
Enable Collision Detection	false	Set whether to enable collision detection after picking.
Bone Name	"hips"	Specify the bone name to grab.
Offset Position	(0, 0, 0)	Specify the offset position from the bone position when picked.
Offset Rotation	(0, 0, 0)	Specify the offset rotation from the bone rotation when picked.
Offset Scale	(1, 1, 1)	Specify the offset scale from the bone scale when picked.

Advanced Options

Label	Initial Value	Function
Clickable	false	Toggle mouse interaction on object.
Auto Loading	true	Used for setting up Dynamic Loading. The object will be loaded on the first load by default.
Light Scattering Target	true	Sets whether the object is affected by scattering when Light Scattering is enabled.
Shadow Caster	false	If Shadow Mapping is enabled, this sets the object's shadow to be casted on other shadow receivers.
Shadow Receiver	false	If Shadow Mapping is enabled, this sets the object to receive shadows from other objects.
Foreground Rendering	false	Sets Foreground Rendering (render without applying depth value).
Depth Buffer Target	true	Sets whether to write to the depth buffer.
Opaque Alpha Blend	false	If this sets true, it forces alpha-blended rendering to be performed in the opaque rendering pass.
Alpha Animation Target	false	Here's the English translation:
Sets whether to make objects transparent when they obstruct the camera's view in order to maintain visibility. For more details, please refer to VKCNodeAlphaAnimation.
Item Render Priority		Designates the Item's render priority. For details, refer to RenderingSettings / Priority List
Show Photo Mode	true	Specifies whether it is displayed in photo mode
Force Raycast Check Disable	false	Sets whether to forcibly disable raycast detection per item
Force Collider Disable	false	Forcibly disables the collider
Begin Actions		Set an Action to trigger when the motion animation starts.
End Actions		Set an Action to trigger when the motion animation ends.

Mode - Pose Settings

Label	Initial Value	Function
.hem		Designate a hem motion file.
Scene Preview	false	Preview the object instantiation on the Unity Scene. Further details are on "Previewing Objects" article.

Mode - Motion Settings

Label	Initial Value	Function
.hem		Designate a hem motion file.
Scene Preview	false	Preview the object instantiation on the Unity Scene. Further details are on "Previewing Objects" article.
Loop	Play the motion in a loop. Turn it on for walking and standby motions.
Draw Circle Shadow	true	Sets to draw a circle shadow on playing motion.
Collision Detection	true	Sets collision detection on playing motion.
Actions		Set an Action to trigger when the motion is played.

Previewing Objects

When enabling the Scene Preview, the designated heo or vrm file will be shown on its instantiating position.

If the "Object Mode" is set to Pose or Motion, the motion's hem file will be converted to Unity AnimationClip for preview.

The slider appearing on enabling scene preview will modify the play position of the VKC Item Object's action.
This slider value is intended for motion previewing, and will not be reflected on the action after build.

Note

If an heo file from previous SDK versions is designated for preview, the model may not be displayed correctly.
If such issue happens, please recreate the heo file.