coordSysAPI.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 USDSHADE_GENERATED_COORDSYSAPI_H
#define USDSHADE_GENERATED_COORDSYSAPI_H


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

#include "pxr/usd/usdGeom/xformable.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;

// -------------------------------------------------------------------------- //
// COORDSYSAPI                                                                //
// -------------------------------------------------------------------------- //

class UsdShadeCoordSysAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI;

    explicit UsdShadeCoordSysAPI(
        const UsdPrim& prim=UsdPrim(), const TfToken &name=TfToken())
        : UsdAPISchemaBase(prim, /*instanceName*/ name)
    { }

    explicit UsdShadeCoordSysAPI(
        const UsdSchemaBase& schemaObj, const TfToken &name)
        : UsdAPISchemaBase(schemaObj, /*instanceName*/ name)
    { }

    USDSHADE_API
    virtual ~UsdShadeCoordSysAPI();

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

    USDSHADE_API
    static TfTokenVector
    GetSchemaAttributeNames(bool includeInherited, const TfToken &instanceName);

    TfToken GetName() const {
        return _GetInstanceName();
    }

    USDSHADE_API
    static UsdShadeCoordSysAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);

    USDSHADE_API
    static UsdShadeCoordSysAPI
    Get(const UsdPrim &prim, const TfToken &name);

    USDSHADE_API
    static std::vector<UsdShadeCoordSysAPI>
    GetAll(const UsdPrim &prim);

    USDSHADE_API
    static bool
    IsSchemaPropertyBaseName(const TfToken &baseName);

    USDSHADE_API
    static bool
    IsCoordSysAPIPath(const SdfPath &path, TfToken *name);

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

    USDSHADE_API
    static UsdShadeCoordSysAPI 
    Apply(const UsdPrim &prim, const TfToken &name);

protected:
    USDSHADE_API
    UsdSchemaKind _GetSchemaKind() const override;

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

    static bool _IsTypedSchema();

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

public:
    // --------------------------------------------------------------------- //
    // BINDING 
    // --------------------------------------------------------------------- //
    USDSHADE_API
    UsdRelationship GetBindingRel() const;

    USDSHADE_API
    UsdRelationship CreateBindingRel() 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)--

    typedef struct {
        TfToken name;
        SdfPath bindingRelPath;
        SdfPath coordSysPrimPath;
    } Binding;

    USDSHADE_API
    bool HasLocalBindings() const;

    USDSHADE_API
    static bool HasLocalBindingsForPrim(const UsdPrim &prim);

    USDSHADE_API
    std::vector<Binding> GetLocalBindings() const;

    USDSHADE_API
    static std::vector<Binding> GetLocalBindingsForPrim(const UsdPrim &prim);

    USDSHADE_API
    Binding GetLocalBinding() const;

    USDSHADE_API
    std::vector<Binding> FindBindingsWithInheritance() const;

    USDSHADE_API
    static std::vector<Binding> FindBindingsWithInheritanceForPrim(
            const UsdPrim &prim);

    USDSHADE_API
    Binding FindBindingWithInheritance() const;

    USDSHADE_API
    bool Bind(const TfToken &name, const SdfPath &path) const;

    USDSHADE_API
    bool ApplyAndBind(const TfToken &name, const SdfPath &path) const;

    USDSHADE_API
    bool Bind(const SdfPath &path) const;

    USDSHADE_API
    bool ClearBinding(const TfToken &name, bool removeSpec) const;

    USDSHADE_API
    bool ClearBinding(bool removeSpec) const;

    USDSHADE_API
    bool BlockBinding(const TfToken &name) const;

    USDSHADE_API
    bool BlockBinding() const;

    //
    //
    USDSHADE_API
    static TfToken GetCoordSysRelationshipName(const std::string &coordSysName);

    USDSHADE_API
    static bool CanContainPropertyName(const TfToken &name);

    USDSHADE_API
    static TfToken GetBindingBaseName(const TfToken &name);

    USDSHADE_API
    TfToken GetBindingBaseName() const;

private:
    USDSHADE_API
    static void _GetBindingsForPrim(const UsdPrim &prim, 
            std::vector<Binding> &result, bool checkExistingBindings=false);

};

PXR_NAMESPACE_CLOSE_SCOPE

#include "pxr/base/tf/envSetting.h"

PXR_NAMESPACE_OPEN_SCOPE
USDSHADE_API
extern TfEnvSetting<std::string> USD_SHADE_COORD_SYS_IS_MULTI_APPLY;

PXR_NAMESPACE_CLOSE_SCOPE

#endif