physxSceneAPI.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PHYSXSCHEMA_GENERATED_PHYSXSCENEAPI_H
#define PHYSXSCHEMA_GENERATED_PHYSXSCENEAPI_H


#include "pxr/pxr.h"
#include ".//api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include ".//tokens.h"

#include "pxr/base/vt/value.h"

#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"

#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"

PXR_NAMESPACE_OPEN_SCOPE

class SdfAssetPath;

// -------------------------------------------------------------------------- //
// PHYSXSCENEAPI                                                              //
// -------------------------------------------------------------------------- //

class PhysxSchemaPhysxSceneAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;

    explicit PhysxSchemaPhysxSceneAPI(const UsdPrim& prim=UsdPrim())
        : UsdAPISchemaBase(prim)
    {
    }

    explicit PhysxSchemaPhysxSceneAPI(const UsdSchemaBase& schemaObj)
        : UsdAPISchemaBase(schemaObj)
    {
    }

    PHYSXSCHEMA_API
    virtual ~PhysxSchemaPhysxSceneAPI();

    PHYSXSCHEMA_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);

    PHYSXSCHEMA_API
    static PhysxSchemaPhysxSceneAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);


    PHYSXSCHEMA_API
    static bool 
    CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);

    PHYSXSCHEMA_API
    static PhysxSchemaPhysxSceneAPI 
    Apply(const UsdPrim &prim);

protected:
    PHYSXSCHEMA_API
    UsdSchemaKind _GetSchemaKind() const override;

private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    PHYSXSCHEMA_API
    static const TfType &_GetStaticTfType();

    static bool _IsTypedSchema();

    // override SchemaBase virtuals.
    PHYSXSCHEMA_API
    const TfType &_GetTfType() const override;

public:
    // --------------------------------------------------------------------- //
    // BOUNCETHRESHOLD 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetBounceThresholdAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateBounceThresholdAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // FRICTIONOFFSETTHRESHOLD 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetFrictionOffsetThresholdAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateFrictionOffsetThresholdAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // FRICTIONCORRELATIONDISTANCE 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetFrictionCorrelationDistanceAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateFrictionCorrelationDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // MAXBIASCOEFFICIENT 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetMaxBiasCoefficientAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateMaxBiasCoefficientAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // COLLISIONSYSTEM 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetCollisionSystemAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateCollisionSystemAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // SOLVERTYPE 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetSolverTypeAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateSolverTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // BROADPHASETYPE 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetBroadphaseTypeAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateBroadphaseTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // FRICTIONTYPE 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetFrictionTypeAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateFrictionTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // ENABLECCD 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetEnableCCDAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateEnableCCDAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // ENABLESTABILIZATION 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetEnableStabilizationAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateEnableStabilizationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // UPDATETYPE 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetUpdateTypeAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateUpdateTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // ENABLEGPUDYNAMICS 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetEnableGPUDynamicsAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateEnableGPUDynamicsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // ENABLEENHANCEDDETERMINISM 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetEnableEnhancedDeterminismAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateEnableEnhancedDeterminismAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // ENABLERESIDUALREPORTING 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetEnableResidualReportingAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateEnableResidualReportingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // ENABLEEXTERNALFORCESEVERYITERATION 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetEnableExternalForcesEveryIterationAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateEnableExternalForcesEveryIterationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // ENABLESCENEQUERYSUPPORT 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetEnableSceneQuerySupportAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateEnableSceneQuerySupportAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // TIMESTEPSPERSECOND 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetTimeStepsPerSecondAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateTimeStepsPerSecondAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUTEMPBUFFERCAPACITY 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuTempBufferCapacityAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuTempBufferCapacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUMAXRIGIDCONTACTCOUNT 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuMaxRigidContactCountAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuMaxRigidContactCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUMAXRIGIDPATCHCOUNT 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuMaxRigidPatchCountAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuMaxRigidPatchCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUHEAPCAPACITY 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuHeapCapacityAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuHeapCapacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUFOUNDLOSTPAIRSCAPACITY 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuFoundLostPairsCapacityAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuFoundLostPairsCapacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUFOUNDLOSTAGGREGATEPAIRSCAPACITY 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuFoundLostAggregatePairsCapacityAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuFoundLostAggregatePairsCapacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUTOTALAGGREGATEPAIRSCAPACITY 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuTotalAggregatePairsCapacityAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuTotalAggregatePairsCapacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUMAXSOFTBODYCONTACTS 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuMaxSoftBodyContactsAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuMaxSoftBodyContactsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUMAXDEFORMABLESURFACECONTACTS 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuMaxDeformableSurfaceContactsAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuMaxDeformableSurfaceContactsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUMAXPARTICLECONTACTS 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuMaxParticleContactsAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuMaxParticleContactsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUMAXHAIRCONTACTS 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuMaxHairContactsAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuMaxHairContactsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUMAXNUMPARTITIONS 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuMaxNumPartitionsAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuMaxNumPartitionsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // GPUCOLLISIONSTACKSIZE 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetGpuCollisionStackSizeAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateGpuCollisionStackSizeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // INVERTCOLLISIONGROUPFILTER 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetInvertCollisionGroupFilterAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateInvertCollisionGroupFilterAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // REPORTKINEMATICKINEMATICPAIRS 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetReportKinematicKinematicPairsAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateReportKinematicKinematicPairsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // REPORTKINEMATICSTATICPAIRS 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetReportKinematicStaticPairsAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateReportKinematicStaticPairsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // MINPOSITIONITERATIONCOUNT 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetMinPositionIterationCountAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateMinPositionIterationCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // MAXPOSITIONITERATIONCOUNT 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetMaxPositionIterationCountAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateMaxPositionIterationCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // MINVELOCITYITERATIONCOUNT 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetMinVelocityIterationCountAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateMinVelocityIterationCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // MAXVELOCITYITERATIONCOUNT 
    // --------------------------------------------------------------------- //
    PHYSXSCHEMA_API
    UsdAttribute GetMaxVelocityIterationCountAttr() const;

    PHYSXSCHEMA_API
    UsdAttribute CreateMaxVelocityIterationCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // ===================================================================== //
    // Feel free to add custom code below this line, it will be preserved by 
    // the code generator. 
    //
    // Just remember to: 
    //  - Close the class declaration with }; 
    //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
    //  - Close the include guard with #endif
    // ===================================================================== //
    // --(BEGIN CUSTOM CODE)--
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif