collision.py

""" Nif User Interface, custom nif properties store for collisions settings"""

# ***** BEGIN LICENSE BLOCK *****
# 
# Copyright © 2005-2015, NIF File Format Library and Tools contributors.
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 
#    * Redistributions of source code must retain the above copyright
#      notice, this list of conditions and the following disclaimer.
# 
#    * Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials provided
#      with the distribution.
# 
#    * Neither the name of the NIF File Format Library and Tools
#      project nor the names of its contributors may be used to endorse
#      or promote products derived from this software without specific
#      prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# ***** END LICENSE BLOCK *****

import bpy
from bpy.props import (PointerProperty,
                       IntProperty,
                       BoolProperty,
                       EnumProperty,
                       FloatProperty,
                       )
from bpy.types import PropertyGroup
from pyffi.formats.nif import NifFormat


class CollisionProperty(PropertyGroup):
    """Group of Havok related properties, which gets attached to objects through a property pointer."""

    @classmethod
    def register(cls):
        # physics
        bpy.types.Object.nifcollision = PointerProperty(
            name='Niftools Collision Property',
            description='Additional collision properties used by the Nif File Format',
            type=cls,
        )

        cls.motion_system = EnumProperty(
            name='Motion System',
            description='Havok Motion System settings for bhkRigidBody(t)',
            items=[(item, item, "", i) for i, item in enumerate(NifFormat.MotionSystem._enumkeys)],
            # default = 'MO_SYS_FIXED',

        )

        cls.oblivion_layer = EnumProperty(
            name='Oblivion Layer',
            description='Mesh color, used in Editor',
            items=[(item, item, "", i) for i, item in enumerate(NifFormat.OblivionLayer._enumkeys)],
            # default = 'OL_STATIC',
        )

        cls.deactivator_type = EnumProperty(
            name='Deactivator Type',
            description='Motion deactivation setting',
            items=[(item, item, "", i) for i, item in enumerate(NifFormat.DeactivatorType._enumkeys)],
        )

        cls.solver_deactivation = EnumProperty(
            name='Solver Deactivation',
            description='Motion deactivation setting',
            items=[(item, item, "", i) for i, item in enumerate(NifFormat.SolverDeactivation._enumkeys)],
        )

        cls.quality_type = EnumProperty(
            name='Quality Type',
            description='Determines quality of motion',
            items=[(item, item, "", i) for i, item in enumerate(NifFormat.MotionQuality._enumkeys)],
            # default = 'MO_QUAL_FIXED',
        )

        cls.col_filter = IntProperty(
            name='Col Filter',
            description='Flags for bhkRigidBody(t)',
            default=0
        )

        cls.max_linear_velocity = FloatProperty(
            name='Max Linear Velocity',
            description='Linear velocity limit for bhkRigidBody(t)',
            default=0
        )

        cls.max_angular_velocity = FloatProperty(
            name='Max Angular Velocity',
            description='Angular velocity limit for bhkRigidBody(t)',
            default=0
        )

        cls.havok_material = EnumProperty(
            name='Havok Material',
            description='The Shapes material',
            items=[(item, item, "", i) for i, item in enumerate(NifFormat.HavokMaterial._enumkeys)],
            # default = 'HAV_MAT_WOOD'
        )

        cls.export_bhklist = BoolProperty(
            name='Export BHKList',
            description='None',
            default=False
        )

        cls.use_blender_properties = BoolProperty(
            name='Use Blender Properties',
            description='Whether or not to export collision settings via blender properties',
            default=False,
        )

    @classmethod
    def unregister(cls):
        del bpy.types.Object.nifcollision